Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Improve MemoryTemporaryStorage documentation #711

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

GarmashAlex
Copy link

@GarmashAlex GarmashAlex commented Jan 11, 2025

Please add the labels corresponding to the type of changes your PR introduces:

  • [+] Documentation (YES)

Description

  • Add comprehensive documentation for MemoryTemporaryStorage struct explaining its purpose and behavior
  • Document remove() method with clear description of its return value
  • Document take() method with explanation of its functionality and return behavior
  • Fix missing documentation for core storage operations

Related Issues

N/A

Testing Performed

DOCUMENTATION

Checklist

  • I have performed a self-review of my own code.
  • The tests pass successfully with cargo test.
  • The code was formatted with cargo fmt.
  • The code compiles with no new warnings with cargo build --release and cargo build --release --features runtime-benchmarks.
  • The code has no new warnings when using cargo clippy.
  • If this change affects documented features or needs new documentation, I have created a PR with a documentation update.

- Add comprehensive documentation for MemoryTemporaryStorage struct explaining its purpose and behavior
- Document remove() method with clear description of its return value
- Document take() method with explanation of its functionality and return behavior
- Fix missing documentation for core storage operations
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant