Skip to content

Commit

Permalink
sagemathgh-38171: fix some details in the documentation of digraph ge…
Browse files Browse the repository at this point in the history
…nerators

### 📝 Checklist

<!-- Put an `x` in all the boxes that apply. -->

- [x] The title is concise and informative.
- [x] The description explains in detail what this PR is about.
- [ ] I have linked a relevant issue or discussion.
- [ ] I have created tests covering the changes.
- [ ] I have updated the documentation and checked the documentation
preview.

### ⌛ Dependencies

<!-- List all open PRs that this PR logically depends on. For example,
-->
<!-- - sagemath#12345: short description why this is a dependency -->
<!-- - sagemath#34567: ... -->

URL: sagemath#38171
Reported by: David Coudert
Reviewer(s): Kwankyu Lee
  • Loading branch information
Release Manager committed Jun 10, 2024
2 parents c03b396 + 4526322 commit 9d74e5f
Show file tree
Hide file tree
Showing 3 changed files with 16 additions and 15 deletions.
4 changes: 2 additions & 2 deletions build/pkgs/configure/checksums.ini
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
tarball=configure-VERSION.tar.gz
sha1=f3e560bbf33add8504ba9f7ba93fff9e82e3e445
sha256=bef93be1bb978fa34cd5aaa9c041d1a97a33ff35f88c9df2f9c25e6764770c56
sha1=e033e5dd8cbfd9fb770c626602d3c52f3314a52e
sha256=09fc6003907cbe038680f06cf6106975533f3f15b47ac14c29296cc5b5c50524
2 changes: 1 addition & 1 deletion build/pkgs/configure/package-version.txt
Original file line number Diff line number Diff line change
@@ -1 +1 @@
5c12765f7e585b58ab0cd99f7998cfa615f85247
2cee80dff830c46cb3627b4a549eb03d1e7c47a1
25 changes: 13 additions & 12 deletions src/sage/graphs/digraph_generators.py
Original file line number Diff line number Diff line change
Expand Up @@ -78,9 +78,9 @@ class DiGraphGenerators:
A class consisting of constructors for several common digraphs,
including orderly generation of isomorphism class representatives.
A list of all graphs and graph structures in this database is
available via tab completion. Type "digraphs." and then hit tab to
see which graphs are available.
A list of all graphs and graph structures in this database is available via
tab completion. Type ``digraphs.`` and then hit :kbd:`Tab` to see which
digraphs are available.
The docstrings include educational information about each named
digraph with the hopes that this class can be used as a reference.
Expand Down Expand Up @@ -567,7 +567,7 @@ def tournaments_nauty(self, n,
- ``options`` -- string; anything else that should be forwarded as input
to Nauty's genbg. See its documentation for more information :
`<http://cs.anu.edu.au/~bdm/nauty/>`_.
`<https://pallini.di.uniroma1.it>`_.
EXAMPLES::
Expand Down Expand Up @@ -639,7 +639,7 @@ def nauty_directg(self, graphs, options="", debug=False):
r"""
Return an iterator yielding digraphs using nauty's ``directg`` program.
Description from directg --help:
Description from ``directg --help``:
Read undirected graphs and orient their edges in all possible ways.
Edges can be oriented in either or both directions (3 possibilities).
Isomorphic directed graphs derived from the same input are suppressed.
Expand All @@ -651,8 +651,8 @@ def nauty_directg(self, graphs, options="", debug=False):
:class:`Graph`. The graph6 string of these graphs is used as an input
for ``directg``.
- ``options`` (str) -- a string passed to directg as if it was run at
a system command line. Available options from directg --help::
- ``options`` -- a string passed to ``directg`` as if it was run at
a system command line. Available options from ``directg --help``::
-e<int> | -e<int>:<int> specify a value or range of the total number of arcs
-o orient each edge in only one direction, never both
Expand All @@ -664,8 +664,8 @@ def nauty_directg(self, graphs, options="", debug=False):
the part number (first is 0) and the second is the number of
parts. Splitting is done per input graph independently.
- ``debug`` -- boolean (default: ``False``); if ``True``
directg standard error and standard output are displayed.
- ``debug`` -- boolean (default: ``False``); if ``True`` ``directg``
standard error and standard output are displayed.
EXAMPLES::
Expand Down Expand Up @@ -807,7 +807,8 @@ def Circuit(self, n):
r"""
Return the circuit on `n` vertices.
The circuit is an oriented ``CycleGraph``.
The circuit is an oriented
:meth:`~sage.graphs.graph_generators.GraphGenerators.CycleGraph`.
EXAMPLES:
Expand Down Expand Up @@ -838,8 +839,8 @@ def Circulant(self, n, integers):
- ``n`` -- integer; number of vertices
- ``integers`` -- iterable container (list, set, etc.) of integers such
that there is an edge from `i` to `j` if and only if ``(j-i)%n in
integers``
that there is an edge from `i` to `j` if and only if `(j-i) \pmod{n}`
is an integer
EXAMPLES::
Expand Down

0 comments on commit 9d74e5f

Please sign in to comment.