Added docstrings to all methods#5
Merged
Merged
Conversation
This file contains hidden or 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
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.
This pull request updates the
nitro-datastorepackage to version 1.0.5 and significantly improves the inline documentation for core methods, making the library easier to use and understand. The changes primarily focus on adding detailed docstrings with usage examples, clarifying method behaviors, and correcting type hints. There are no changes to the core logic or functionality.Documentation improvements for
NitroDataStoremethods:has,merge,to_dict, andsavemethods inNitroDataStore, clarifying behaviors such as deep copying, mutation, error handling, and file output. [1] [2] [3]Documentation and type hint improvements for
QueryBuilder:group_byinQueryBuilder, clarified behavior for non-dict items and missing keys, and updated the return type toDict[Any, List[Any]].Dictto the imports inquery_builder.pyto support the improved type hinting.Version bump:
__init__.pyandpyproject.toml. [1] [2]