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.

Sign up for GitHub

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

Jump to bottom

DOC: Amend robustness documentation #2479

Merged
merged 1 commit into from
Feb 27, 2024
Merged

DOC: Amend robustness documentation #2479

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 5 additions & 3 deletions docs/user/robustness.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,15 +27,17 @@ that they should fix their stuff.

pypdf gives you the option to be strict or not.

pypdf has three core objects and all of them have a `strict` parameter:
pypdf has two core objects:

* [`PdfReader`](../modules/PdfReader.md)
* [`PdfWriter`](../modules/PdfWriter.md)
* [`PdfMerger`](../modules/PdfMerger.md)

Only the PdfReader has a `strict` parameter, since presumably you do not want
to write a non-conforming PDF.

Choosing `strict=True` means that pypdf will raise an exception if a PDF does
not follow the specification.

Choosing `strict=False` means that pypdf will try to be forgiving and do
something reasonable, but it will log a warning message. It is a best-effort
approach.
approach.
Loading