Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Refactor docx_comments. Closes #541. #544

Merged
merged 1 commit into from
Jan 20, 2024

Conversation

trekonom
Copy link
Contributor

This PR refactors docx_comments to (properly) account for comments spanning
multiple paragraphs, nested comments, multiple comments in the same paragraph and replies. Closes #541.

  • Adds a test document to check that docx_comments accounts for these "special" cases found in real-world documents.

  • The dataframe returned by docx_comments() gains a list column para_id containing
    the id(s) of the parent paragraph(s). A possible breaking change is that the commented_text
    is now returned as a list column to account for comments spanning multiple runs.

  • The docs gain a description of the columns of the returned dataframe.

…ng multiple paragraphs, multiple comments in the same paragraph and replies. Closes davidgohel#541. Update docs to include a detailed description of the columns in the returned dataframe.
@codecov-commenter
Copy link

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (58f5c52) 72.61% compared to head (9a44f52) 73.24%.
Report is 1 commits behind head on master.

❗ Your organization needs to install the Codecov GitHub app to enable full functionality.

Additional details and impacted files
@@            Coverage Diff             @@
##           master     #544      +/-   ##
==========================================
+ Coverage   72.61%   73.24%   +0.63%     
==========================================
  Files          40       40              
  Lines        5499     5494       -5     
==========================================
+ Hits         3993     4024      +31     
+ Misses       1506     1470      -36     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@davidgohel
Copy link
Owner

@trekonom it looks good to me. Thank you very much for the preciously documented and tested work, it's really very pleasant.

@davidgohel davidgohel merged commit 312daa5 into davidgohel:master Jan 20, 2024
5 checks passed
@trekonom trekonom deleted the issue-541 branch May 18, 2024 10:01
@trekonom trekonom restored the issue-541 branch May 18, 2024 10:01
@trekonom trekonom deleted the issue-541 branch May 18, 2024 12:07
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Nov 21, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

docx_comments bugs
3 participants