Skip to content

Commit f4de6e2

Browse files
committed
Footnotes are discouraged
1 parent 3732839 commit f4de6e2

File tree

1 file changed

+8
-7
lines changed

1 file changed

+8
-7
lines changed

documentation/markup.rst

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -661,14 +661,21 @@ Syntax highlighting is handled in a smart way:
661661

662662
Longer displays of verbatim text may be included by storing the example text in
663663
an external file containing only plain text. The file may be included using the
664-
``literalinclude`` directive. [1]_ For example, to include the Python source
664+
``literalinclude`` directive. For example, to include the Python source
665665
file :file:`example.py`, use::
666666

667667
.. literalinclude:: example.py
668668

669669
The file name is relative to the current file's path. Documentation-specific
670670
include files should be placed in the ``Doc/includes`` subdirectory.
671671

672+
.. note::
673+
674+
There is a standard ``include`` directive, but it raises errors if the
675+
file is not found. ``literalinclude`` is preferred because it only emits a
676+
warning instead of raising an error.
677+
678+
672679
.. _rest-inline-markup:
673680
.. _roles:
674681

@@ -1288,9 +1295,3 @@ default. They are set in the build configuration file :file:`conf.py`.
12881295

12891296
Replaced by either today's date, or the date set in the build configuration
12901297
file. Normally has the format ``April 14, 2007``.
1291-
1292-
1293-
.. rubric:: Footnotes
1294-
1295-
.. [1] There is a standard ``include`` directive, but it raises errors if the
1296-
file is not found. This one only emits a warning.

0 commit comments

Comments
 (0)