Added full docstrings for all public methods#2
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 adds comprehensive docstrings to the public API of the
nitro_imglibrary, significantly improving its documentation and usability for developers. The changes clarify the behavior, parameters, return values, and usage examples for classes, methods, and exceptions throughout the codebase. Additionally, the project version is incremented to reflect these enhancements.The most important changes are:
Batch Processing Documentation Improvements:
BatchImageclass and all its public methods inbatch.py, including usage examples, parameter explanations, and return value descriptions. This provides clear guidance on how to use batch image processing features. [1] [2] [3] [4]Configuration and Error Handling Documentation:
Configclass inconfig.pywith a comprehensive class-level docstring and detailed method documentation, explaining configuration options and how to update them. [1] [2]errors.py, describing when each error is raised and its intended usage.Presets and Utility Documentation:
Presetsclass and its methods (thumbnail,avatar, etc.) inpresets.py, including parameter details, return values, and code examples for common image tasks. [1] [2] [3]Version Bump:
1.0.1to1.0.2in bothpyproject.tomland__init__.pyto reflect these documentation improvements. [1] [2]