Added missing docstrings and bumped the version#13
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 focuses on improving the developer experience by enhancing and expanding the inline documentation (docstrings) across several core modules of the Nitro static site generator. The changes provide clearer usage examples, detail class attributes and methods, and explain key behaviors, making the codebase much more accessible for both new and existing contributors. No functional or behavioral changes were made; all updates are to documentation and metadata.
Key improvements include:
Expanded and Clarified Docstrings
Configclass inconfig.py, detailing its attributes, initialization, and role in project configuration. [1] [2]Envclass inenv.py, including clearer explanations of environment variable access patterns, lazy loading, and example usages for all methods. [1] [2] [3]Image Optimization Pipeline Documentation
ImageConfig,OptimizedImage, andImageOptimizerclasses inimages.py, including method-level documentation forget_srcset,get_src,optimize_image,generate_picture_element, andprocess_html. These now include attribute descriptions, examples, and clearer explanations of return values and behavior. [1] [2] [3] [4] [5] [6] [7] [8]Islands Architecture Documentation
IslandConfigandIslandinislands.py, including attribute explanations, hydration strategies, and usage examples. TheIsland.render()method now documents its output and error handling. [1] [2] [3]Metadata and Version Updates
pyproject.tomland__init__.pyto1.0.14to reflect these documentation improvements. [1] [2]