Skip to content

Added docstrings for all methods#1

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

Added docstrings for all methods#1
sn merged 1 commit into
mainfrom
feature/added-docstrings

Conversation

@sn
Copy link
Copy Markdown
Contributor

@sn sn commented Apr 17, 2026

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 the HookRegistry class 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 for PluginBase, including a usage example and detailed attribute descriptions. Improved module-level documentation. [1] [2]

Other Minor Changes:

No logic or API changes were introduced; all updates are documentation-only for improved clarity and maintainability.

@sn sn self-assigned this Apr 17, 2026
@sn sn merged commit d2f5370 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