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

texinfo: fix emission of @footnote directives. #9390

Merged
merged 3 commits into from Dec 11, 2021

Conversation

marxin
Copy link
Contributor

@marxin marxin commented Jun 30, 2021

Right now, labels are emitted as part of a @footnote directive.
That results in e.g.

Note1: (@footnote{@w{(1)}
Future versions of GCC may zero-extend...
})

which is incorrect and should be rather:

Note1: (@footnote{Future versions of GCC may zero-extend...})

@marxin
Copy link
Contributor Author

marxin commented Jun 30, 2021

Copy link
Member

@tk0miya tk0miya left a comment

Choose a reason for hiding this comment

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

LGTM with nits.

sphinx/writers/texinfo.py Show resolved Hide resolved
sphinx/writers/texinfo.py Show resolved Hide resolved
sphinx/writers/texinfo.py Outdated Show resolved Hide resolved
tests/test_build_texinfo.py Outdated Show resolved Hide resolved
Right now, labels are emitted as part of a @footnote directive.
That results in e.g.

Note1: (@footnote{@w{(1)}
Future versions of GCC may zero-extend...
})

which is incorrect and should be rather:

Note1: (@footnote{Future versions of GCC may zero-extend...})
@marxin
Copy link
Contributor Author

marxin commented Aug 5, 2021

@tk0miya May I please remind this pull request where I asked some questions?

@tk0miya tk0miya modified the milestones: 4.2.0, 4.3.0 Sep 12, 2021
@tk0miya tk0miya modified the milestones: 4.3.0, 4.4.0 Nov 9, 2021
The CR character was added for readability of output.  But it makes the
texinfo writer a bit complicated.  This removes it from output to keep
our code simple (reducing conditions).
@tk0miya tk0miya merged commit d743f21 into sphinx-doc:4.x Dec 11, 2021
@tk0miya
Copy link
Member

tk0miya commented Dec 11, 2021

Merged. Thank you for your contribution!

tk0miya added a commit that referenced this pull request Dec 11, 2021
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Jan 11, 2022
@marxin marxin deleted the fix-footnote-in-info branch September 9, 2022 10:29
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants