Skip to content

Addded correct docstrings to all surface api's#9

Merged
sn merged 1 commit into
mainfrom
feature/doctring-improvements
Apr 17, 2026
Merged

Addded correct docstrings to all surface api's#9
sn merged 1 commit into
mainfrom
feature/doctring-improvements

Conversation

@sn
Copy link
Copy Markdown
Contributor

@sn sn commented Apr 17, 2026

This pull request focuses on significantly improving the documentation and clarity of the HTMLElement class 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:

  • Added a comprehensive class docstring to HTMLElement, explaining its purpose, usage patterns, and attribute conventions.
  • Updated docstrings for all major methods in 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]
  • Improved the docstring for the template method in Component, clarifying how props and slots are handled.

Other minor updates:

  • Bumped the package version from 1.0.9 to 1.0.10 in pyproject.toml to reflect these documentation improvements.

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