Skip to content

DOC: Add comments to page module #3319

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

Merged
merged 4 commits into from
Jun 22, 2025
Merged

DOC: Add comments to page module #3319

merged 4 commits into from
Jun 22, 2025

Conversation

MartinThoma
Copy link
Member

@MartinThoma MartinThoma commented Jun 19, 2025

Just some comments + a tiny refactoring. Both hopefully make the code a little bit easier to read :-)

Oh, and process_operation should very likely rather be called process_operator (I can undo that if you think the previous name fits better :-) )

@stefan6419846
Copy link
Collaborator

An operation takes an operator and parameters (operands) and evaluates them, thus I think that process_operation fits better. But this probably is a matter of taste.

Copy link

codecov bot commented Jun 19, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 96.71%. Comparing base (bd9fff0) to head (3c833f5).
Report is 1 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #3319   +/-   ##
=======================================
  Coverage   96.71%   96.71%           
=======================================
  Files          53       53           
  Lines        9046     9046           
  Branches     1675     1675           
=======================================
  Hits         8749     8749           
  Misses        177      177           
  Partials      120      120           

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

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Let's just add comments instead
@MartinThoma MartinThoma force-pushed the page-module-comments branch from 2ae4f44 to 1978c23 Compare June 19, 2025 08:03
@MartinThoma MartinThoma changed the title MAINT: Add _flush_text and comments to page module DOC: Add comments to page module Jun 19, 2025
@MartinThoma
Copy link
Member Author

@stefan6419846 I undid the name change + the tiny refactoring as it increased the cyclomatic complexity and thus made the test fail -.-

Now it's a comment-only PR 😄

@stefan6419846
Copy link
Collaborator

Slightly related to #3010, where the goal is to refactor this rather complex method as well to increase readability and modularization.

@stefan6419846
Copy link
Collaborator

Could you please unify the casing of the comments to always start with an uppercase letter?

@MartinThoma
Copy link
Member Author

Could you please unify the casing of the comments to always start with an uppercase letter?

Done 👍

@stefan6419846 stefan6419846 merged commit 80ace50 into main Jun 22, 2025
16 checks passed
@stefan6419846 stefan6419846 deleted the page-module-comments branch June 22, 2025 14:36
larsga pushed a commit to larsga/pypdf that referenced this pull request Jul 21, 2025
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.

2 participants