FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

docs(mutations): add Attributes sections to the remaining op docstrings by ernesthenry · Pull Request #66 · pythonnative/pythonnative · GitHub

Repository navigation

docs(mutations): add Attributes sections to the remaining op docstrings - #66

Merged
owenthcarey merged 1 commit into
pythonnative:mainfrom
ernesthenry:docs/mutation-op-docstrings
Sep 3, 2026
Merged

owenthcarey merged 1 commit into
pythonnative:mainfrom
ernesthenry:docs/mutation-op-docstrings

Conversation

Copy link
Copy Markdown
Contributor

What

  • Added Google-style Attributes: sections to UpdateOp, InsertOp, DestroyOp, and SetFrameOp docstrings in src/pythonnative/mutations.py.

Why

  • Only CreateOp had an Attributes: section; its sibling ops lacked field documentation.
  • On the rendered docs/api/mutations.md page, CreateOp had a formatted attributes table while the other four ops didn't. Adding these sections ensures consistent API reference docs and satisfies repository docstring conventions.

How (brief)

  • Documented tag and changed_props on UpdateOp (noting None for removed props).
  • Documented parent_tag, child_tag, and index on InsertOp (noting handler clamping).
  • Documented tag on DestroyOp.
  • Documented tag, x, y, width, and height on SetFrameOp.

Testing

  • Ran uv run ruff check . (passed).
  • Ran uv run --group docs mkdocs build --strict (passed; verified rendered attributes tables on the Mutation ops page).
  • Ran ./scripts/check.sh (all CI checks passed).

Risks/Impact

  • None. Docstrings-only change.

Docs/Follow-ups

  • None.

Closes #61

owenthcarey merged commit 9cb8f9b into pythonnative:main Sep 3, 2026
15 checks passed

Copy link
Copy Markdown
Contributor

Thank you so much!

Copy link
Copy Markdown
Contributor Author

@owenthcarey you are welcome

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add Attributes: sections to the UpdateOp, InsertOp, DestroyOp, and SetFrameOp docstrings

2 participants


Back | FazBrowse Home | New Git URL