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

Jump to bottom

Doc: use "unnumbered" footnotes #98954

Merged
merged 1 commit into from Nov 1, 2022
Merged

Doc: use "unnumbered" footnotes #98954

merged 1 commit into from Nov 1, 2022
+2 −2

Conversation

humitos
Copy link
Contributor

@humitos humitos commented Nov 1, 2022

Use unnumbered footnote in this file to avoid reseting the footnotes numbering.

Example: when building the tutorial into a PDF and using latex_show_urls = "footnotes"; this footnote become the number 8. However, without this change, the footnote shows the number 1.

@humitos
Doc: use "unnumbered" footnotes
d56cf0e 
Use unnumbered footnote in this file to avoid reseting the footnotes numbering.

Example: when building the tutorial into a PDF and using `latex_show_urls = "footnotes"`; this footnote become the number 8. However, without this change, the footnote shows the number 1.
@bedevere-bot bedevere-bot added awaiting review docs Documentation in the Doc dir skip news labels Nov 1, 2022
@humitos humitos mentioned this pull request Nov 1, 2022
Closed
@kumaraditya303 kumaraditya303 requested a review from AlexWaygood Nov 1, 2022
AA-Turner
AA-Turner approved these changes Nov 1, 2022
View changes
Copy link
Member

@AA-Turner AA-Turner left a comment

Thanks!

A

AA-Turner
AA-Turner approved these changes Nov 1, 2022
View changes
Copy link
Member

@AA-Turner AA-Turner left a comment

Thanks!

A

@AlexWaygood AlexWaygood merged commit f042646 into python:main Nov 1, 2022
14 checks passed
@miss-islington
Copy link
Contributor

miss-islington commented Nov 1, 2022

Thanks @humitos for the PR, and @AlexWaygood for merging it 🌮🎉.. I'm working now to backport this PR to: 3.10.
🐍🍒⛏🤖 I'm not a witch! I'm not a witch!

@miss-islington
Copy link
Contributor

miss-islington commented Nov 1, 2022

Thanks @humitos for the PR, and @AlexWaygood for merging it 🌮🎉.. I'm working now to backport this PR to: 3.11.
🐍🍒⛏🤖 I'm not a witch! I'm not a witch!

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Nov 1, 2022
@humitos @miss-islington
Doc: use "unnumbered" footnotes (pythonGH-98954)
32fe496 
Use unnumbered footnote in this file to avoid reseting the footnotes numbering.

Example: when building the tutorial into a PDF and using `latex_show_urls = "footnotes"`; this footnote become the number 8. However, without this change, the footnote shows the number 1.
(cherry picked from commit f042646)

Co-authored-by: Manuel Kaufmann <humitos@gmail.com>
@bedevere-bot
Copy link

bedevere-bot commented Nov 1, 2022

GH-98960 is a backport of this pull request to the 3.10 branch.

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Nov 1, 2022
@humitos @miss-islington
Doc: use "unnumbered" footnotes (pythonGH-98954)
2fecd01 
Use unnumbered footnote in this file to avoid reseting the footnotes numbering.

Example: when building the tutorial into a PDF and using `latex_show_urls = "footnotes"`; this footnote become the number 8. However, without this change, the footnote shows the number 1.
(cherry picked from commit f042646)

Co-authored-by: Manuel Kaufmann <humitos@gmail.com>
@bedevere-bot
Copy link

bedevere-bot commented Nov 1, 2022

GH-98961 is a backport of this pull request to the 3.11 branch.

miss-islington added a commit that referenced this pull request Nov 1, 2022
@miss-islington @humitos
Doc: use "unnumbered" footnotes (GH-98954)
129de5d 
Use unnumbered footnote in this file to avoid reseting the footnotes numbering.

Example: when building the tutorial into a PDF and using `latex_show_urls = "footnotes"`; this footnote become the number 8. However, without this change, the footnote shows the number 1.
(cherry picked from commit f042646)

Co-authored-by: Manuel Kaufmann <humitos@gmail.com>
miss-islington added a commit that referenced this pull request Nov 1, 2022
@miss-islington @humitos
Doc: use "unnumbered" footnotes (GH-98954)
8648c06 
Use unnumbered footnote in this file to avoid reseting the footnotes numbering.

Example: when building the tutorial into a PDF and using `latex_show_urls = "footnotes"`; this footnote become the number 8. However, without this change, the footnote shows the number 1.
(cherry picked from commit f042646)

Co-authored-by: Manuel Kaufmann <humitos@gmail.com>
@AlexWaygood
Copy link
Member

AlexWaygood commented Nov 1, 2022

Thanks @humitos! I've backported this to 3.11 and 3.10.

@humitos
Copy link
Contributor Author

humitos commented Nov 1, 2022

Wow! Thanks you all! That was fast 🚀

@CAM-Gerlach
Copy link
Member

CAM-Gerlach commented Nov 2, 2022

Just FYI, this is called "autonumbered" footnotes.

Also, in the future I'd suggest always using autonumbered footnotes with brief descriptive names (e.g. [#return-mutated-object] or something else appropriate), rather than anonymous autonumbered footnotes, which ensures references always point to the right footnote and don't get out of sync. Otherwise, it is otherwise very easy for the footnote references to point to the wrong footnote if footnotes are ever added, moved or deleted (and can be non-trivial to fix them, with nothing but implicit context to go by), which is a more serious problem then just a reset in the numbering. This is _especially true when the footnotes are at the end of a long document like this one.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@AA-Turner AA-Turner

@AlexWaygood AlexWaygood

@CAM-Gerlach CAM-Gerlach

Assignees
No one assigned
Labels
docs Documentation in the Doc dir skip issue skip news
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
7 participants
@humitos @miss-islington @bedevere-bot @AlexWaygood @CAM-Gerlach @AA-Turner @kumaraditya303