Skip to content

Commit 1e40a1c

Browse files
codexjames-d-mitchell
authored andcommitted
doc: fixes in rst files
1 parent da692f4 commit 1e40a1c

5 files changed

Lines changed: 15 additions & 15 deletions

File tree

docs/source/authors.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010
Authors
1111
=======
1212

13-
- `Reinis Cirpons`_ (rc234@st-andrews.ac.uk)_
13+
- `Reinis Cirpons`_ (rc234@st-andrews.ac.uk)
1414
- `Joseph Edwards`_ (jde1@st-andrews.ac.uk)
1515
- `James Mitchell`_ (jdm3@st-andrews.ac.uk)
1616
- `Maria Tsalakou`_ (mt200@st-andrews.ac.uk)

docs/source/changelog-v1.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -99,11 +99,11 @@ This is a major release that significantly expands the API of
9999
``libsemigroups_pybind11`` to expose much of the functionality implemented in
100100
version 3 of libsemigroups_. The extent of the changes made in this release
101101
means that it is likely that any code written with earlier versions of
102-
``libsemigroups_pybin11`` will no longer work.
102+
``libsemigroups_pybind11`` will no longer work.
103103

104104
The structure of ``libsemigroups_pybind11`` is very tightly linked to the
105105
structure of libsemigroups_. Therefore, some of the differences between
106-
v0.10.1 and v1.0.0 of ``libsemigroups_pyind11`` will be related to the
106+
v0.10.1 and v1.0.0 of ``libsemigroups_pybind11`` will be related to the
107107
differences between v2 and v3 of libsemigroups_, such as changes to class names
108108
and interfaces. These changes can be found in the
109109
`libsemigroups changelog <https://libsemigroups.github.io/libsemigroups/md_changelog-v3.html>`_.

docs/source/data-structures/presentations/to-inverse-present.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -94,11 +94,11 @@ specify the following values for *args*:
9494
Additionally, specify one of the following for *rtype*:
9595

9696
- ``(InversePresentation, str)`` for constructing an
97-
- :any:`InversePresentation` over words of type ``str``.
97+
:any:`InversePresentation` over words of type ``str``.
9898
- ``(InversePresentation, list[int])`` for constructing an
9999
:any:`InversePresentation` over words of type ``list[int]``.
100100

101-
This function behaves in one of two ways, depending on type of words in *p*, and
101+
This function behaves in one of two ways, depending on type of words in *ip*, and
102102
the type of words specified in *rtype*:
103103

104104
1. When the type of words in *ip* and type of words specified in *rtype*
@@ -151,8 +151,8 @@ not the same as that specified in *rtype* or
151151

152152
.. _inverse-presentation-and-function-to-inverse-presentation:
153153

154-
Converting an :any:`InversePresentation` to n :any:`InversePresentation` with a function
155-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
154+
Converting an :any:`InversePresentation` to an :any:`InversePresentation` with a function
155+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
156156

157157
To construct a :any:`InversePresentation` from a :any:`InversePresentation`
158158
using a custom letter conversion function, specify the following values for

docs/source/data-structures/presentations/to-present.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -175,7 +175,7 @@ Additionally, specify one of the following for *rtype*:
175175
the same type as that in *kb*.
176176
- ``(Presentation, str)`` for constructing a :any:`Presentation` over words
177177
of type ``str``.
178-
- ``(Presentation, list[int]`` for constructing a :any:`Presentation` over
178+
- ``(Presentation, list[int])`` for constructing a :any:`Presentation` over
179179
words of type ``list[int]``.
180180

181181
This function constructs and returns a :any:`Presentation` object using the

docs/source/main-algorithms/knuth-bendix/to-knuth-bendix.rst

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -100,9 +100,9 @@ following values for *args*:
100100
Additionally, specify one of the following for *rtype*:
101101

102102
- ``(KnuthBendix, 'RewriteTrie')`` for constructing a :any:`KnuthBendix`
103-
with the ``RewriteTrie'`` rewriter.
103+
with the ``RewriteTrie`` rewriter.
104104
- ``(KnuthBendix, 'RewriteFromLeft')`` for constructing a :any:`KnuthBendix`
105-
with the ``RewriteFromLeft'`` rewriter.
105+
with the ``RewriteFromLeft`` rewriter.
106106

107107
This function converts a :any:`ToddCoxeter` object *tc* to a :any:`KnuthBendix`
108108
object with the rewriter as specified above, using
@@ -155,21 +155,21 @@ following values for *args*:
155155
Additionally, specify one of the following for *rtype*:
156156

157157
- ``(KnuthBendix, str, 'RewriteTrie')`` for constructing a
158-
:any:`KnuthBendix` on words with type ``str`` using the ``RewriteTrie'``
158+
:any:`KnuthBendix` on words with type ``str`` using the ``RewriteTrie``
159159
rewriter.
160160
- ``(KnuthBendix, list[int], 'RewriteTrie')`` for constructing a
161161
:any:`KnuthBendix` on words with type ``list[int]`` using the
162-
``RewriteTrie'`` rewriter.
162+
``RewriteTrie`` rewriter.
163163
- ``(KnuthBendix, str, 'RewriteFromLeft')`` for constructing a
164164
:any:`KnuthBendix` on words with type ``str`` using the
165-
``RewriteFromLeft'`` rewriter.
165+
``RewriteFromLeft`` rewriter.
166166
- ``(KnuthBendix, list[int], 'RewriteFromLeft')`` for constructing a
167167
:any:`KnuthBendix` on words with type ``list[int]`` using the
168-
``RewriteFromLeft'`` rewriter.
168+
``RewriteFromLeft`` rewriter.
169169

170170
This function converts a :any:`FroidurePin` object *fpb* to a :any:`KnuthBendix`
171171
object with the word type and rewriter as specified above. This is done using
172-
the presentation obtained from ``to(fpb, rtype=(Presentation, Word)`` where
172+
the presentation obtained from ``to(fpb, rtype=(Presentation, Word))`` where
173173
``Word`` is either ``str`` or ``list[int]``.
174174

175175
This returned :any:`KnuthBendix` object represents the trivial congruence over

0 commit comments

Comments
 (0)