Footnotes are discouraged #1290
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
willingc
approved these changes
Mar 19, 2024
documentation/markup.rst
Outdated
| .. note:: | ||
| There is a standard ``include`` directive, but it raises errors if the | ||
| file is not found. ``literalinclude`` is preferred because it only emits a | ||
| warning in that case. |
There was a problem hiding this comment.
@nedbat Can you clarify "in that case" please? Perhaps "...because it emits a warning instead of an error."
hugovk
approved these changes
Mar 19, 2024
nedbat
force-pushed
the
nedbat/no-footnotes
branch
from
a6793e0
to
f4de6e2
Compare
|
I assumed it was because it doesn't stop the build, but I could be wrong. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This is a better way to explain more about
literalinclude馃摎 Documentation preview 馃摎: https://cpython-devguide--1290.org.readthedocs.build/