Add comprehensive docstrings to MongoDB and Redis modules #18
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
update v0.1.2
Merge develop into main; Bump to v0.1.3
…src/db/mongo_db.rs and src/db/redis_cache.rs. the docstrings should include a description of the purpose, as well as any arguments where applicable. Only work on src/db/mongo_db.rs and src/db/redis_cache.rs, no other files
BHouwens
approved these changes
Jan 26, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Add Comprehensive Docstrings to MongoDB and Redis Modules
Summary
This PR adds comprehensive docstrings to all functions, traits, and structs in the
src/db/mongo_db.rsandsrc/db/redis_cache.rsfiles. The docstrings include descriptions of the purpose of each item, as well as details about arguments, connection handling, query execution, caching semantics, and error cases.Context
The goal of this PR is to improve the documentation of the MongoDB and Redis modules, making it easier for developers to understand and use these components. The changes are isolated to the specified files and do not affect other parts of the codebase.
Testing
No functional changes were made, so existing tests should continue to pass. To verify the docstrings, review the updated files and ensure that all functions, traits, and structs have clear and accurate documentation.
Known Issues or Limitations