Added docstrings for all methods#1
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 significantly improves the documentation and docstrings throughout the Nitro Dispatch core, making the codebase much easier to understand and use. It clarifies the purpose and usage of key classes and methods, provides detailed explanations and examples for exceptions, and standardizes the format of docstrings. There are no functional or behavioral changes to the code itself.
The most important changes are:
Documentation and Docstring Improvements:
nitro_dispatch/core/exceptions.py: Expanded and clarified docstrings for all custom exceptions, explaining their purpose, usage, and context. Added module-level documentation describing the exception hierarchy.nitro_dispatch/core/hook_registry.py: Overhauled docstrings for theHookRegistryclass and all its methods, providing detailed descriptions, argument/return documentation, and usage examples. Improved module-level documentation. [1] [2] [3] [4] [5] [6] [7] [8]nitro_dispatch/core/plugin_base.py: Enhanced class and method docstrings forPluginBase, including a usage example and detailed attribute descriptions. Improved module-level documentation. [1] [2]Other Minor Changes:
nitro_dispatch/__init__.py: Bumped the package version to1.0.2.No logic or API changes were introduced; all updates are documentation-only for improved clarity and maintainability.