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

DOC: Minor readability increases #2515

Merged
merged 1 commit into from Mar 11, 2024
Merged

Conversation

j-t-1
Copy link
Contributor

@j-t-1 j-t-1 commented Mar 11, 2024

  1. Sort the API reference, de-emphasizing the deprecated PdfMerger.
  2. Add new lines to .pre-commit-config.yaml.

1. Sort the API reference, de-emphasizing the deprecated PdfMerger.
2. Add new lines to .pre-commit-config.yaml.
@j-t-1
Copy link
Contributor Author

j-t-1 commented Mar 11, 2024

  1. "The PdfReader Class" could be renamed to just "PdfReader". Similarly for the others, so removing "The" and "Class" to reduce noise.
  2. Not related to readability, but is this file needed: /pypdf/py.typed?

@stefan6419846
Copy link
Collaborator

Not related to readability, but is this file needed: /pypdf/py.typed?

Yes, this indicates that we provide typing information for type checkers.

Copy link

codecov bot commented Mar 11, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 94.54%. Comparing base (29683d3) to head (b036ad3).

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #2515   +/-   ##
=======================================
  Coverage   94.54%   94.54%           
=======================================
  Files          49       49           
  Lines        8173     8173           
  Branches     1658     1658           
=======================================
  Hits         7727     7727           
  Misses        276      276           
  Partials      170      170           

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

@j-t-1
Copy link
Contributor Author

j-t-1 commented Mar 11, 2024

Not related to readability, but is this file needed: /pypdf/py.typed?

Yes, this indicates that we provide typing information for type checkers.

Useful to know.
Thoughts on renaming "The PdfReader Class" to "PdfReader" to reduce noise?

@stefan6419846
Copy link
Collaborator

I do not think that this is required - these are the API docs which provide details to the developer and thus might be more verbose. Additionally, it makes it easier to differentiate between modules and classes (although PEP8 naming might already indicate this, but better explicit than implicit).

@stefan6419846 stefan6419846 added the nf-documentation Non-functional change: Documentation label Mar 11, 2024
@stefan6419846 stefan6419846 merged commit c943f5f into py-pdf:main Mar 11, 2024
15 checks passed
@j-t-1 j-t-1 deleted the readability branch March 11, 2024 12:41
stefan6419846 added a commit that referenced this pull request Apr 7, 2024
REL: 4.2.0

## What's new

### New Features (ENH)
- Allow multiple charsets for NameObject.read_from_stream (#2585) by @pubpub-zz
- Add support for /Kids in page labels (#2562) by @stefan6419846
- Allow to update fields on many pages (#2571) by @pubpub-zz
- Tolerate PDF with invalid xref pointed objects (#2335) by @pubpub-zz
- Add Enforce from PDF2.0 in viewer_preferences (#2511) by @pubpub-zz
- Add += and -= operators to ArrayObject (#2510) by @pubpub-zz

### Bug Fixes (BUG)
- Fix merge_page sometimes generating unknown operator 'QQ' (#2588) by @rfotino
- Fix fields update where annotations are kids of field (#2570) by @pubpub-zz
- Process CMYK images without a filter correctly (#2557) by @pubpub-zz
- Extract text in layout mode without finding resources (#2555) by @pubpub-zz
- Prevent recursive loop in some PDF files (#2505) by @pubpub-zz

### Robustness (ROB)
- Tolerate "truncated" xref (#2580) by @pubpub-zz
- Replace error by warning for EOD in RunLengthDecode/ASCIIHexDecode (#2334) by @pubpub-zz
- Rebuild xref table if one entry is invalid (#2528) by @pubpub-zz
- Robustify stream extraction (#2526) by @pubpub-zz

### Documentation (DOC)
- Update release process for latest changes (#2564) by @stefan6419846
- Encryption/decryption: Clone document instead of copying all pages (#2546) by @redfast00
- Minor improvements (#2542) by @j-t-1
- Update annotation list (#2534) by @j-t-1
- Update references and formatting (#2529) by @j-t-1
- Correct threads reference, plus minor changes (#2521) by @j-t-1
- Minor readability increases (#2515) by @j-t-1
- Simplify PaperSize examples (#2504) by @j-t-1
- Minor improvements (#2501) by @j-t-1

### Developer Experience (DEV)
- Remove unused dependencies (#2572) by @stefan6419846
- Remove page labels PR link from message (#2561) by @stefan6419846
- Fix changelog generator regarding whitespace and handling of "Other" group (#2492) by @stefan6419846
- Add REL to known PR prefixes (#2554) by @stefan6419846
- Release using the REL commit instead of git tag (#2500) by @MartinThoma
- Unify code between PdfReader and PdfWriter (#2497) by @pubpub-zz
- Bump softprops/action-gh-release from 1 to 2 (#2514) by @dependabot[bot]

### Maintenance (MAINT)
- Ressources → Resources (and internal name childs) (#2550) by @pubpub-zz
- Fix typos found by codespell (#2549) by @stefan6419846
- Update Read the Docs configuration (#2538) by @j-t-1
- Add root_object, _info and _ID to PdfReader (#2495) by @pubpub-zz

### Testing (TST)
- Allow loading truncated images if required (#2586) by @stefan6419846
- Fix download issues from #2562 (#2578) by @pubpub-zz
- Improve test_get_contents_from_nullobject to show real use-case (#2524) by @stefan6419846
- Add missing test annotations (#2507) by @stefan6419846

[Full Changelog](4.1.0...4.2.0)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
nf-documentation Non-functional change: Documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants