Skip to content

DOC: Link to CONTRIBUTING.md in README.md#2232

Merged
MartinThoma merged 2 commits intopy-pdf:mainfrom
mp3403:patch-1
Oct 7, 2023
Merged

DOC: Link to CONTRIBUTING.md in README.md#2232
MartinThoma merged 2 commits intopy-pdf:mainfrom
mp3403:patch-1

Conversation

@mp3403
Copy link
Copy Markdown
Contributor

@mp3403 mp3403 commented Oct 1, 2023

Added link to CONTRIBUTING.md in the "Contributions" section and added three common questions and answers in the Q&A section.

Added link to CONTRIBUTING.md in the "Contributions" section and added common questions and answers in the Q&A section.
@stefan6419846
Copy link
Copy Markdown
Collaborator

Where do these FAQ come from? If ever, shouldn't these rather be part of the official docs instead of the README?

Additionally, the extractText method is deprecated in favor of extract_text: https://pypdf.readthedocs.io/en/latest/modules/PageObject.html?pypdf._page.PageObject.extractText#pypdf._page.PageObject.extractText

README.md Outdated

**How can I use pypdf to merge pdf files?**

Use the <code>PdfMerger</code> class. The <code>append</code> method is great for simply concatenating files, but <code>merge</code> can be used
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

PdfMerger is obsolete. PdfWriter has to be used instead

README.md Outdated

**How can I extract text from a pdf?**

There are several ways of extracting text from a pdf file using pypdf. The <code>extractText</code> method is likely the simplest way of doing this.
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

link to the proper documentation page should be added

@MartinThoma
Copy link
Copy Markdown
Member

The link to CONTRIBUTING is fine. Please remove the rest.

@MartinThoma MartinThoma changed the title DOC: Update README.md DOC: Link to CONTRIBUTING.md in README.md Oct 7, 2023
@MartinThoma MartinThoma merged commit f3b7bf8 into py-pdf:main Oct 7, 2023
@pubpub-zz
Copy link
Copy Markdown
Collaborator

@MartinThoma Have you consiredered my comments ?

@MartinThoma
Copy link
Copy Markdown
Member

MartinThoma commented Oct 7, 2023

@pubpub-zz I have removed those parts from the PR as they are already covered in a cleaner way in the very top of the README.

Did I miss something?

@pubpub-zz
Copy link
Copy Markdown
Collaborator

all good, I was just questionning based on the replies to my comments.

@MartinThoma
Copy link
Copy Markdown
Member

MartinThoma commented Oct 7, 2023

I do agree to your comments 👍

But I also think we should not add any of the paragraphs you commented on, hence they are not relevant any longer.

MartinThoma added a commit that referenced this pull request Oct 8, 2023
## What's new

### Bug Fixes (BUG)
-  invalid cm/tm in visitor functions (#2206) by @pubpub-zz
-  Encrypt / decrypt Stream object dictionaries (#2228) by @pilotandy
-  Support nested color spaces for the /DeviceN color space (#2241) by @Stefan
-  images property fails if NullObject in list (#2215) by @pubpub-zz

### Robustness (ROB)
-  XYZ destination to cope with missing left and top param (#2237) by @pubpub-zz

### Documentation (DOC)
-  Add pilotandy for #2228 as a contributor by @MartinThoma
-  Link to CONTRIBUTING.md in README.md (#2232) by @markpfeifle
-  Changelog by @MartinThoma

### Developer Experience (DEV)
-  Exclude tests from mypy checks by @MartinThoma
-  Unify mypy options and warn redundant workarounds (#2223) by @exiledkingcc
-  Stabilize Pillow test with Pillow missing (#2229) by @Stefan

### Maintenance (MAINT)
-  Update pinned packages (#2243) by @MartinThoma

### Testing (TST)
-  Regression test against non-deterministic accidental object reuse (#2244) by @MartinThoma

[Full Changelog](3.16.2...3.16.3)
@mp3403 mp3403 deleted the patch-1 branch October 9, 2023 22:14
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.

4 participants