Skip to content

[codex] fix comments guide API attributes#1554

Open
Sean-Kenneth-Doherty wants to merge 1 commit into
python-openxml:masterfrom
Sean-Kenneth-Doherty:codex/fix-comments-doc-attrs
Open

[codex] fix comments guide API attributes#1554
Sean-Kenneth-Doherty wants to merge 1 commit into
python-openxml:masterfrom
Sean-Kenneth-Doherty:codex/fix-comments-doc-attrs

Conversation

@Sean-Kenneth-Doherty
Copy link
Copy Markdown

Summary

  • update the comments guide example to use the public comment.comment_id and comment.timestamp attributes
  • add the missing comma in the Document.add_comment() example call
  • fix the same-page RST emphasis warning for block-item container

Fixes #1551

Validation

  • uv run --python 3.9 --with-requirements requirements-docs.txt sphinx-build -b html -d docs/.build/doctrees docs docs/.build/html
  • git diff --check

AI assistance: prepared with OpenAI Codex.

@Sean-Kenneth-Doherty Sean-Kenneth-Doherty marked this pull request as ready for review May 16, 2026 23:23
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.

The documentation of the "comments" API does not use the correct attributes

1 participant