Addded correct docstrings to all surface api's#9
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 significantly improving the documentation and clarity of the
HTMLElementclass and its methods in the NitroUI library. The changes add detailed docstrings, clarify method behaviors, and provide usage examples, making the API much more approachable for users and contributors. There are no functional or behavioral changes—only enhancements to documentation and developer experience.Enhanced documentation and clarity:
HTMLElement, explaining its purpose, usage patterns, and attribute conventions.HTMLElement(e.g.,__init__,append,prepend,add_attribute,add_style,filter, etc.) to include descriptions of arguments, return values, raised exceptions, and usage examples. [1] [2] [3] [4] [5] [6] [7] [8] [9] [10] [11] [12] [13]templatemethod inComponent, clarifying how props and slots are handled.Other minor updates:
1.0.9to1.0.10inpyproject.tomlto reflect these documentation improvements.