Skip to content

Commit def8e56

Browse files
author
Matthias Koeppe
committed
Minor fixes
1 parent cb87e98 commit def8e56

File tree

3 files changed

+7
-8
lines changed

3 files changed

+7
-8
lines changed

src/doc/en/developer/coding_in_python.rst

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -128,8 +128,7 @@ support the command ``latex``.
128128
illustrates LaTeX generation for your object.
129129

130130
#. You can use any macros included in ``amsmath``, ``amssymb``, or
131-
``amsfonts``, or the ones defined in
132-
:sage_root:`doc/commontex/macros.tex`.
131+
``amsfonts``, or the ones defined in :mod:`sage.misc.latex_macros`.
133132

134133
An example template for a ``_latex_`` method follows. Note that the
135134
``.. skip`` line should not be included in your code; it is here to
@@ -162,7 +161,7 @@ Print representation
162161
====================
163162

164163
The standard Python printing method is ``__repr__(self)``. In Sage,
165-
that is for objects that derive from ``SageObject`` (which is
164+
that is for objects that derive from :class:`SageObject` (which is
166165
everything in Sage), instead define ``_repr_(self)``. This is
167166
preferable because if you only define ``_repr_(self)`` and not
168167
``__repr__(self)``, then users can rename your object to print however
@@ -647,17 +646,17 @@ When importing from other Python libraries that do not provide sufficient typing
647646
information, it is possible to augment the library's typing information for
648647
the purposes of typechecking the Sage library:
649648

650-
- Create typestub files and place them in the directory :sage_root:`src/typings`.
649+
- Create typestub files and place them in the directory :file:`SAGE_ROOT/src/typings`.
651650
For example, the distribution **pplpy** provides the top-level package :mod:`ppl`,
652651
which publishes no typing information. We can create a typestub file
653-
:sage_root:`src/typings/ppl.pyi` or :sage_root:`src/typings/ppl/__init__.pyi`.
652+
:file:`SAGE_ROOT/src/typings/ppl.pyi` or :file:`SAGE_ROOT/src/typings/ppl/__init__.pyi`.
654653

655654
- When these typestub files are working well, it is preferable from the viewpoint
656655
of the Sage project that they are "upstreamed", i.e., contributed to the
657656
project that maintains the library. If a new version of the upstream library
658657
becomes available that provides the necessary typing information, we can
659658
update the package in the Sage distribution and remove the typestub files again
660-
from :sage_root:`src/typings`.
659+
from :file:`SAGE_ROOT/src/typings`.
661660

662661
- As a fallback, when neither adding typing annotations to source files
663662
nor adding typestub files is welcomed by the upstream project, it is possible

src/doc/en/developer/packaging_sage_library.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -687,7 +687,7 @@ command::
687687

688688
This command does not make any changes to the normal installation of
689689
Sage. The virtual environment is created in a subdirectory of
690-
:sage_root:`pkgs/sagemath-standard/.tox/`. After the command
690+
:file:`SAGE_ROOT/pkgs/sagemath-standard/.tox/`. After the command
691691
finishes, we can start the separate installation of the Sage library
692692
in its virtual environment::
693693

src/doc/en/developer/sage_manuals.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ order to build a **html** version of this document, type::
5151

5252
sage --docbuild tutorial html
5353

54-
You can now open :sage_root:`local/share/doc/sage/html/en/tutorial/index.html` in
54+
You can now open :file:`SAGE_ROOT/local/share/doc/sage/html/en/tutorial/index.html` in
5555
your web browser.
5656

5757
- Do you want to **add a new file** to the documentation? :ref:`Click here

0 commit comments

Comments
 (0)