Skip to content

Commit

Permalink
Trac #15719: Fix documentation bugs
Browse files Browse the repository at this point in the history
The following documentation bugs need to be fixed for Sage-6.1:
{{{
[combinat ] /usr/local/src/sage-git/local/lib/python2.7/site-
packages/sage/combinat/designs/block_design.py:docstring of
sage.combinat.designs.block_design:3: WARNING: Block quote ends without
a blank line; unexpected unindent.
[combinat ] /usr/local/src/sage-git/local/lib/python2.7/site-
packages/sage/combinat/designs/block_design.py:docstring of
sage.combinat.designs.block_design:22: WARNING: Block quote ends without
a blank line; unexpected unindent.
[combinat ] /usr/local/src/sage-git/local/lib/python2.7/site-
packages/sage/combinat/designs/block_design.py:docstring of
sage.combinat.designs.block_design.ProjectiveGeometryDesign:6: ERROR:
Undefined substitution referenced: "F|^{d+1}-1} {|F".

[arithgrou] docstring of sage.modular.arithgroup.arithgroup_element.Arit
hmeticSubgroupElement.acton:46: WARNING: Literal block expected; none
found.

[graphs   ] /home/release/Sage/src/doc/en/reference/graphs/sage/graphs/g
eneric_graph.rst:312: WARNING: autodoc can't import/find function
'sage.graphs.generic_graph._scream_if_not_simple', it reported error:
"_scream_if_not_simple", please check your spelling and sys.path
[graphs   ] /home/release/Sage/local/lib/python2.7/site-
packages/sage/graphs/graph.py:docstring of
sage.graphs.graph.Graph.is_tree:16: WARNING: Inline interpreted text or
phrase reference start-string without end-string.
[graphs   ] /home/release/Sage/local/lib/python2.7/site-
packages/sage/graphs/graph.py:docstring of sage.graphs.graph:16:
WARNING: Block quote ends without a blank line; unexpected unindent.
[graphs   ] /home/release/Sage/src/doc/en/reference/graphs/sage/graphs/g
raph_generators.rst:6: WARNING: Duplicate explicit target name:
"corresponding wolfram page".
[graphs   ] /home/release/Sage/src/doc/en/reference/graphs/sage/graphs/g
raph_generators.rst:6: WARNING: Duplicate explicit target name: "wolfram
page".

[tutorial ] /home/release/Sage/src/doc/fr/tutorial/latex.rst:454:
WARNING: undefined label: sec-sagetex (if the link has no caption the
label must precede a section header)
[tutorial ] /home/release/Sage/src/doc/fr/tutorial/tour_linalg.rst:87:
WARNING: undefined label: section-rings (if the link has no caption the
label must precede a section header)
}}}

URL: http://trac.sagemath.org/15719
Reported by: vbraun
Ticket author(s): Marc Mezzarobba, Martin Raum, Nathann Cohen
Reviewer(s): Volker Braun
  • Loading branch information
Release Manager authored and vbraun committed Jan 30, 2014
2 parents 1bd3319 + 974532d commit 022e2ce
Show file tree
Hide file tree
Showing 7 changed files with 23 additions and 21 deletions.
2 changes: 2 additions & 0 deletions src/doc/fr/tutorial/sagetex.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
.. _sec-sagetex:

****************
Utiliser SageTeX
****************
Expand Down
2 changes: 2 additions & 0 deletions src/doc/fr/tutorial/tour_rings.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
.. _section-rings:

***************
Anneaux de base
***************
Expand Down
6 changes: 3 additions & 3 deletions src/sage/combinat/designs/block_design.py
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,7 @@ def ProjectiveGeometryDesign(n, d, F, algorithm=None):
A projective geometry design of parameters `n,d,F` has for points the lines
of `F^{n+1}`, and for blocks the `d+1`-dimensional subspaces of `F^{n+1}`,
each of which contains `\frac {|F|^{d+1}-1} {|F|-1}` lines.
each of which contains `\\frac {|F|^{d+1}-1} {|F|-1}` lines.
INPUT:
Expand All @@ -107,8 +107,8 @@ def ProjectiveGeometryDesign(n, d, F, algorithm=None):
EXAMPLES:
The points of the following design are the `\frac {2^{2+1}-1} {2-1}=7` lines
of `\mathbb{Z}_2^{2+1}`. It has `7` blocks, corresponding to each
The points of the following design are the `\\frac {2^{2+1}-1} {2-1}=7`
lines of `\mathbb{Z}_2^{2+1}`. It has `7` blocks, corresponding to each
2-dimensional subspace of `\mathbb{Z}_2^{2+1}`::
sage: designs.ProjectiveGeometryDesign(2, 1, GF(2))
Expand Down
16 changes: 8 additions & 8 deletions src/sage/graphs/generators/smallgraphs.py
Original file line number Diff line number Diff line change
Expand Up @@ -1419,8 +1419,8 @@ def KittellGraph():
r"""
Returns the Kittell Graph.
For more information on the Kittell Graph, see the `corresponding Wolfram
page <http://mathworld.wolfram.com/KittellGraph.html>`_.
For more information, see the `Wolfram page about the Kittel Graph
<http://mathworld.wolfram.com/KittellGraph.html>`_.
EXAMPLES::
Expand Down Expand Up @@ -3153,8 +3153,8 @@ def MarkstroemGraph():
Returns the Markström Graph.
The Markström Graph is a cubic planar graph with no cycles of length 4 nor
8, but containing cycles of length 16. For more information on the Markström
Graph, see the `corresponding Wolfram page
8, but containing cycles of length 16. For more information, see the
`Wolfram page about the Markström Graph
<http://mathworld.wolfram.com/MarkstroemGraph.html>`_.
EXAMPLES::
Expand Down Expand Up @@ -4137,10 +4137,10 @@ def WienerArayaGraph():
Returns the Wiener-Araya Graph.
The Wiener-Araya Graph is a planar hypohamiltonian graph on 42 vertices and
67 edges. For more information on the Wiener-Araya Graph, see its
corresponding `Wolfram Page
<http://mathworld.wolfram.com/Wiener-ArayaGraph.html>`_ or its `(french)
Wikipedia page <http://fr.wikipedia.org/wiki/Graphe_de_Wiener-Araya>`_.
67 edges. For more information, see the `Wolfram Page on the Wiener-Araya
Graph <http://mathworld.wolfram.com/Wiener-ArayaGraph.html>`_ or its
`(french) Wikipedia page
<http://fr.wikipedia.org/wiki/Graphe_de_Wiener-Araya>`_.
EXAMPLES::
Expand Down
2 changes: 0 additions & 2 deletions src/sage/graphs/generic_graph.py
Original file line number Diff line number Diff line change
Expand Up @@ -315,8 +315,6 @@
class GenericGraph(GenericGraph_pyx):
"""
Base class for graphs and digraphs.

.. autofunction:: _scream_if_not_simple
"""

# Nice defaults for plotting arrays of graphs (see sage.misc.functional.show)
Expand Down
2 changes: 1 addition & 1 deletion src/sage/graphs/graph.py
Original file line number Diff line number Diff line change
Expand Up @@ -1790,7 +1790,7 @@ def is_tree(self, certificate=False, output='vertex'):
When the certificate cycle is given as a list of edges, the
edges are given as `(v_i, v_{i+1}, l)` where `v_1, v_2, \dots,
v\n` are the vertices of the cycles (in their cyclic order).
v_n` are the vertices of the cycles (in their cyclic order).
EXAMPLES::
Expand Down
14 changes: 7 additions & 7 deletions src/sage/modular/arithgroup/arithgroup_element.pyx
Original file line number Diff line number Diff line change
Expand Up @@ -36,14 +36,14 @@ cdef class ArithmeticSubgroupElement(MultiplicativeGroupElement):
INPUT:
- parent - an arithmetic subgroup
- ``parent`` -- an arithmetic subgroup
- x - data defining a 2x2 matrix over ZZ
which lives in parent
- `x` -- data defining a 2x2 matrix over ZZ
which lives in parent
- check - if True, check that parent
is an arithmetic subgroup, and that
x defines a matrix of determinant 1.
- ``check`` -- if True, check that parent is an arithmetic
subgroup, and that `x` defines a matrix of
determinant `1`.
We tend not to create elements of arithmetic subgroups that aren't
SL2Z, in order to avoid coercion issues (that is, the other arithmetic
Expand Down Expand Up @@ -363,7 +363,7 @@ cdef class ArithmeticSubgroupElement(MultiplicativeGroupElement):
sage: g.acton(Cusp(-31/15))
+Infinity
TESTS::
TESTS:
We cover the remaining case, i.e., infinity mapped to infinity::
Expand Down

0 comments on commit 022e2ce

Please sign in to comment.