Skip to content

Fix broken anchor links#1877

Merged
andersonhc merged 5 commits into
py-pdf:masterfrom
iamfazakb:fix-broken-anchor-links
Jul 2, 2026
Merged

Fix broken anchor links#1877
andersonhc merged 5 commits into
py-pdf:masterfrom
iamfazakb:fix-broken-anchor-links

Conversation

@iamfazakb

@iamfazakb iamfazakb commented Jun 30, 2026

Copy link
Copy Markdown

Just changed some anchor links to directly take you to their API documentation instead of just leaving you at the top of the page. The pages and their sections were:
https://py-pdf.github.io/fpdf2/TextRegion.html#general-operation
https://py-pdf.github.io/fpdf2/Margins.html#margins
https://py-pdf.github.io/fpdf2/PageFormatAndOrientation.html#page-layout-zoom-level
https://py-pdf.github.io/fpdf2/TextColumns.html#text-columns
https://py-pdf.github.io/fpdf2/Images.html#output-intents

Fixes #1876

  • I have confirmed the links that I modified work correctly

Is writing changes to the documentations in CHANGELOG.md necessary?

  • A mention of the change is present in CHANGELOG.md

  • This PR is ready to be merged

This is my first time contributing and I was really nervous. That's why I decided to start small to get used to it. I would really appreciate advice and criticism.

By submitting this pull request, I confirm that my contribution is made under the terms of the GNU LGPL 3.0 license.

@iamfazakb

Copy link
Copy Markdown
Author

I also found some links that lead to the documentation instead of the API reference.

For example: https://py-pdf.github.io/fpdf2/Links.html#hyperlink-with-write_html
In this section, FPDF.write_html takes to the page https://py-pdf.github.io/fpdf2/HTML.html instead of the API documentation.

Just wanted to ask if this is intentional.

@andersonhc

Copy link
Copy Markdown
Collaborator

Just wanted to ask if this is intentional.

Doesn't look intentional to me - linking to the API reference would make more sense. Do you want to add this change?

Also, can you add a quick CHANGELOG.md entry saying you fixed several links on the docs?

I'm good to merge after that.

@iamfazakb

iamfazakb commented Jul 1, 2026

Copy link
Copy Markdown
Author

Doesn't look intentional to me - linking to the API reference would make more sense. Do you want to add this change?

Yes, I can add this change I'll also add a CHANGELOG.md entry stating the changes.
Would just a single line be enough saying that I fixed a few broken anchor links.

@andersonhc

Copy link
Copy Markdown
Collaborator

Doesn't look intentional to me - linking to the API reference would make more sense. Do you want to add this change?

Yes, I can add this change I'll also add a CHANGELOG.md entry stating the changes. Would just a single line be enough saying that I fixed a few broken anchor links.

Yes. One line is more than enough

@iamfazakb

iamfazakb commented Jul 2, 2026

Copy link
Copy Markdown
Author

@andersonhc, I have completed the changes. Should I do anything else?
Is mentioning maintainers like this frowned upon?

@andersonhc

Copy link
Copy Markdown
Collaborator

@allcontributors please add @iamfazakb for docs

@allcontributors

Copy link
Copy Markdown

@andersonhc

I've put up a pull request to add @iamfazakb! 🎉

@andersonhc andersonhc merged commit bd11e75 into py-pdf:master Jul 2, 2026
22 of 23 checks passed
@andersonhc

Copy link
Copy Markdown
Collaborator

@andersonhc, I have completed the changes. Should I do anything else? Is mentioning maintainers like this frowned upon?

No worries about mentioning people :)

The PR has been merged. Thank you for your contribution.

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.

Some links in the documentation don't directly lead to their function.

2 participants