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: Document core mechanics of pypdf #1783

Merged
merged 13 commits into from
Apr 19, 2023
Merged

DOC: Document core mechanics of pypdf #1783

merged 13 commits into from
Apr 19, 2023

Conversation

MartinThoma
Copy link
Member

@MartinThoma MartinThoma commented Apr 10, 2023

I want to document how pypdf reads/writes PDF files

For reviewers

@MartinThoma MartinThoma marked this pull request as draft April 12, 2023 18:51
@codecov
Copy link

codecov bot commented Apr 16, 2023

Codecov Report

Patch coverage: 100.00% and no project coverage change.

Comparison is base (bd140cb) 93.39% compared to head (d2573c3) 93.39%.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #1783   +/-   ##
=======================================
  Coverage   93.39%   93.39%           
=======================================
  Files          34       34           
  Lines        6612     6614    +2     
  Branches     1301     1301           
=======================================
+ Hits         6175     6177    +2     
  Misses        285      285           
  Partials      152      152           
Impacted Files Coverage Δ
pypdf/_writer.py 87.57% <100.00%> (+0.02%) ⬆️

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report in Codecov by Sentry.
📢 Do you have feedback about the report comment? Let us know in this issue.

@MartinThoma MartinThoma requested a review from pubpub-zz April 16, 2023 06:44
@MartinThoma MartinThoma marked this pull request as ready for review April 16, 2023 06:44
@MartinThoma
Copy link
Member Author

@pubpub-zz I think I'm happy now. Could you please check if it is correct / makes sense?

Copy link
Collaborator

@pubpub-zz pubpub-zz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This sounds good to me.
Perhaps adding some reference to the pdf ref (1.7? 2.0?)

@pubpub-zz
Copy link
Collaborator

Schön 😊

Copy link
Member

@Lucas-C Lucas-C left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice documentation addition!

I don't know pypdf enough yet to make many constructive suggestions,
but elements could be added later on,
and it's definitively a good start!

docs/dev/pypdf-parsing.md Outdated Show resolved Hide resolved
docs/dev/pypdf-parsing.md Show resolved Hide resolved
docs/dev/pypdf-parsing.md Outdated Show resolved Hide resolved
docs/dev/pypdf-writing.md Outdated Show resolved Hide resolved
docs/dev/pypdf-writing.md Outdated Show resolved Hide resolved
@MartinThoma MartinThoma merged commit 914c43e into main Apr 19, 2023
@MartinThoma MartinThoma deleted the docs-inner-workings branch April 19, 2023 20:40
MartinThoma added a commit that referenced this pull request Apr 23, 2023
Bug Fixes (BUG)
-  Convert color space before saving (#1802)

Documentation (DOC)
-  PDF/A (#1807)
-  Use append instead of add_page
-  Document core mechanics of pypdf (#1783)

[Full Changelog](3.8.0...3.8.1)
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.

3 participants