feat: add comments support #1495
Open
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
Provides access to the comments collection from the document object.
Provide a way to get a `Comments` object from the `DocumentPart`.
Also involves adding `CommentsPart.default`. Because the comments part is optional, we need a mechanism to add a default (empty) comments part when one is not present. This is what `CommentsPart.default()` is for.
CommentsPart is loaded as XML-part on document deserialization.
To get a comment by id, None when not found.
Actual implementation is primarily inherited from `BlockItemContainer`, but support for those operations must be present in `CT_Comment` and it's worth testing explicitly.
Only with `text` parameter so far. Author and initials parameters to follow.
- allow setting on construction - allow update with property setters
- developer/analysis docs - user docs - API docs
This was referenced Jun 13, 2025
2 tasks
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 adds support for comments, primarily via the
document.add_comment()method and thedocument.commentsaccessor for the newCommentscollection.These allow new comments to be added to a document and existing comments to be inspected and their author metadata and content modified.
There is no direct support for accessing the document text "referenced" by a comment (the comment "anchor") although that may be added later.