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: Correct the example of adding highlight annotation #2341

Merged
merged 3 commits into from Dec 23, 2023
Merged

DOC: Correct the example of adding highlight annotation #2341

merged 3 commits into from Dec 23, 2023

Conversation

Tobeabellwether
Copy link
Contributor

Fix example for Add the Highlight:
the pypdf.annotations.Highlight requires rect and quad_points as input parameters not vertices

@Tobeabellwether
Update adding-pdf-annotations.md
2928e30 
Fix example for Add the Highlight:
the `pypdf.annotations.Highlight` requires `rect` and `quad_points` as input parameters not `vertices`
@stefan6419846
Copy link
Collaborator

Could you please update the PR title to be more meaningful and follow the usual pattern from https://pypdf.readthedocs.io/en/latest/dev/intro.html#commit-messages?

@Tobeabellwether Tobeabellwether changed the title Update adding-pdf-annotations.md DOC: Update adding-pdf-annotations.md Dec 13, 2023
@Tobeabellwether Tobeabellwether changed the title DOC: Update adding-pdf-annotations.md DOC: Correct the example of adding highlight annotation Dec 13, 2023
stefan6419846
stefan6419846 approved these changes Dec 20, 2023
View reviewed changes
Copy link
Collaborator

@stefan6419846 stefan6419846 left a comment

Choose a reason for hiding this comment

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

LGTM.

@MartinThoma MartinThoma merged commit 27409ba into py-pdf:main Dec 23, 2023
@MartinThoma
Copy link
Member

@Tobeabellwether Thank you for your contribution 🤗 If you want, I can add you to https://pypdf.readthedocs.io/en/latest/meta/CONTRIBUTORS.html :-)

@MartinThoma
Copy link
Member

@stefan6419846 Thank you for the review and giving feedback so fast 🙏

@MartinThoma
Copy link
Member

@stefan6419846 You are super active at pypdf recently. I've just noticed that your review is handled differently (look at the color):

image

It seems also not to count to the minimum-1-review requirement. Most likely as you're not formally a collaborator at pypdf.

May I add you with read-permissions to pypdf? That should not change a lot, except that you're officially marked as a collaborator + your review counts to the merge requirements.

@stefan6419846
Copy link
Collaborator

You are super active at pypdf recently.

There probably are meany reasons for this, but as an active user of at least some of the features and when seeing easy/relevant bugs/warnings in our monitoring, giving back to the upstream project is one of the activities we/I consider valuable/essential for a healthy project future.

It seems also not to count to the minimum-1-review requirement. Most likely as you're not formally a collaborator at pypdf.

This most likely is correct.

May I add you with read-permissions to pypdf? That should not change a lot, except that you're officially marked as a collaborator + your review counts to the merge requirements.

I am open for this and will not argue against this ;)

MartinThoma added a commit that referenced this pull request Dec 24, 2023
@MartinThoma
REL: 3.17.4
54a30cb 
## What's new

### Bug Fixes (BUG)
-  Handle IndirectObject as image filter (#2355) by @stefan6419846

### Documentation (DOC)
-  Quote specs in generate_file_identifiers (#2363) by @exiledkingcc
-  Notes about form fields and annotations (#1945) by @dmjohnsson23
-  Notes about update_page_form_field_values(auto_regenerate) (#2359) by @dmjohnsson23
-  Fix stamping example (#2358) by @dmjohnsson23
-  Stamp images directly on a PDF (#2357) by @dmjohnsson23
-  Correct the example of adding highlight annotation (#2341) by @Tobeabellwether

### Maintenance (MAINT)
-  Update upload-artifact and download-artifact actions from v3 to v4 (#2352) by @stefan6419846

### Testing (TST)
-  Add xfail test for #2336 (#2365) by @MartinThoma
-  Increase test coverage for flate handling of image mode 1 (#2339) by @stefan6419846

### Code Style (STY)
-  File identifier generation restructuring (#2362) by @exiledkingcc
-  Add PdfWriter._ID attribute (#2361) by @exiledkingcc
-  Variable naming convention (#2360) by @MartinThoma

[Full Changelog](3.17.3...3.17.4)
@Tobeabellwether
Copy link
Contributor Author

@Tobeabellwether Thank you for your contribution 🤗 If you want, I can add you to https://pypdf.readthedocs.io/en/latest/meta/CONTRIBUTORS.html :-)

@MartinThoma it's my pleasure to contribute to pypdf, you can add me 🤝🏻

MartinThoma added a commit that referenced this pull request Dec 25, 2023
@MartinThoma
DOC: Add Tobeabellwether as a contributor for #2341
5ea40d6
@stefan6419846 stefan6419846 mentioned this pull request Jan 6, 2024
Merged
MartinThoma added a commit that referenced this pull request Jan 19, 2024
@MartinThoma
REL: 4.0.0
26b9a97 
## What's new

pypdf==4.0.0 is a big milestone forward:

* We finally have a layout-mode text extraction.
  This enables users who want to detect / extract tables
  with heuristics to give it a try.
* We deprecated a lot of the old PyPDF2 API that was either
  not following PEP8 naming styles or was not using a
  property. Users comming from PyPDF2 might want to switch
  first to pypdf<4.0.0 to get helpful error messages
  that show the new API in their speicific cases.

A big 'Thank you!' the the whole pypdf community for your
work. Thanks to you, pypdf is better than ever.

Kudos to @shartzog who added the layout-mode with his first
contribution!

### Deprecations (DEP)
-  Drop Python 3.6 support (#2369) by @MartinThoma
-  Remove deprecated code (#2367) by @MartinThoma
-  Remove deprecated XMP properties (#2386) by @stefan6419846

### New Features (ENH)
-  Add "layout" mode for text extraction (#2388) by @shartzog
-  Add Jupyter Notebook integration for PdfReader (#2375) by @MartinThoma
-  Improve/rewrite PDF permission retrieval (#2400) by @stefan6419846

### Bug Fixes (BUG)
-  PdfWriter.add_uri was setting the wrong type (#2406) by @pmiller66
-  Add support for GBK2K cmaps (#2385) by @stefan6419846

### Documentation (DOC)
-  Add pmiller66 for #2406 as a contributor by @MartinThoma
-  Add missing expand parameter (#2393) by @Atomnp
-  Resolve build warnings (#2380) by @stefan6419846
-  Fix testing prerequisites (#2381) by @stefan6419846
-  Improve formatting of contributors page (#2383) by @stefan6419846
-  Add Tobeabellwether as a contributor for #2341 by @MartinThoma

### Developer Experience (DEV)
-  Make dependabot aware of our PR prefixes (#2415) by @stefan6419846
-  Fail on Sphinx issues (#2405) by @stefan6419846
-  Move title check to own workflow (#2384) by @MasterOdin
-  Write to temporary files instead of the working directory (#2379) by @stefan6419846
-  Ensure that the PR titles have the correct format (#2378) by @stefan6419846

### Maintenance (MAINT)
-  Complete FileSpecificationDictionaryEntries constants (#2416) by @MartinThoma
-  Return None instead of -1 when page is not attached (#2376) by @MartinThoma
-  Replace warning with logging.error (#2377) by @MartinThoma

### Testing (TST)
-  Add missing pytest.mark.samples annotations (#2412) by @kitterma
-  Correctly close temporary files (#2396) by @stefan6419846
-  Fix  side effect #2379 (#2395) by @pubpub-zz
-  Add test for layout extraction mode (#2390) by @MartinThoma

### Code Style (STY)
-  Use the UserAccessPermissions enum (#2398) by @MartinThoma
-  Run black (#2370) by @MartinThoma

[Full Changelog](3.17.4...4.0.0)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@MartinThoma MartinThoma MartinThoma approved these changes

@stefan6419846 stefan6419846 stefan6419846 approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
3 participants
@Tobeabellwether @stefan6419846 @MartinThoma