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

Enhance Documentation on merging rotated PDFs #1655

Closed
Lars147 opened this issue Feb 23, 2023 · 7 comments · Fixed by #2247
Closed

Enhance Documentation on merging rotated PDFs #1655

Lars147 opened this issue Feb 23, 2023 · 7 comments · Fixed by #2247
Assignees
Labels
nf-documentation Non-functional change: Documentation

Comments

@Lars147
Copy link

Lars147 commented Feb 23, 2023

Explanation

Documentation on the function pdf_page.transfer_rotation_to_content() would be a great benefit. I had a hard time figuring out what I was missing when merging a rotated pdf file.

@pubpub-zz
Copy link
Collaborator

@Lars147 can you from your better understanding, contribute and propose a PR?

@pubpub-zz pubpub-zz added the nf-documentation Non-functional change: Documentation label Feb 23, 2023
@MartinThoma
Copy link
Member

Here is an example how a documentation PR can look like: #1647

@pubpub-zz
Copy link
Collaborator

@Lars147
+1 ?

@amaank404
Copy link

Believe me when I say this, it took me a while to figure this out. +1

@MartinThoma
Copy link
Member

@amaank404 Do you want to improve the documentation?

@stefan6419846
Copy link
Collaborator

This is already documented for at least the stamping/watermarking docs.

@amaank404
Copy link

This is already documented for at least the stamping/watermarking docs.

I beg to differ, I started by reading the API Docs directly. I suppose it would be better if a little reference to this apply function was present. Like a footnote that to actually apply the values to the elements, please look at this function (Important for merging purposes).

I am taking up this issue, I propose to add a reference to the rotate functions of pageobject and transform function of the pageobject. I will do so once I get approval from people here.

MartinThoma pushed a commit that referenced this issue Oct 10, 2023
This reworks the docs on merging PDF files to quite some extent:

* Formatting: Make it consistent
* Language: Improve typos and formulations
* Duplication: Avoid reproducing the complete parameter set of methods in the tutorial. Point to the API reference instead.
* Content: Add an example for `page.transfer_rotation_to_content()`.

Fixes #1655
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 a pull request may close this issue.

5 participants