Skip to content

Commit 4f735b1

Browse files
author
Matthias Koeppe
committed
Minor fixes
1 parent aa877c7 commit 4f735b1

File tree

3 files changed

+7
-8
lines changed

3 files changed

+7
-8
lines changed

src/doc/en/developer/coding_in_python.rst

+5-6
Original file line numberDiff line numberDiff line change
@@ -127,8 +127,7 @@ support the command ``latex``.
127127
illustrates LaTeX generation for your object.
128128

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

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

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

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

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

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

src/doc/en/developer/packaging_sage_library.rst

+1-1
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

+1-1
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)