Skip to content

Added docstrings to all methods#5

Merged
sn merged 1 commit into
mainfrom
feature/adding-docstrings
Apr 17, 2026
Merged

Added docstrings to all methods#5
sn merged 1 commit into
mainfrom
feature/adding-docstrings

Conversation

@sn

@sn sn commented Apr 17, 2026

Copy link
Copy Markdown
Contributor

This pull request updates the nitro-datastore package 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 NitroDataStore methods:

  • Added comprehensive docstrings with usage examples to the has, merge, to_dict, and save methods in NitroDataStore, clarifying behaviors such as deep copying, mutation, error handling, and file output. [1] [2] [3]

Documentation and type hint improvements for QueryBuilder:

  • Improved the docstring for group_by in QueryBuilder, clarified behavior for non-dict items and missing keys, and updated the return type to Dict[Any, List[Any]].
  • Added Dict to the imports in query_builder.py to support the improved type hinting.

Version bump:

  • Updated the package version to 1.0.5 in both __init__.py and pyproject.toml. [1] [2]

@sn sn self-assigned this Apr 17, 2026
@sn sn merged commit 50fc052 into main Apr 17, 2026
6 checks passed
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