to: correct doc "rtype" not "Result"

Author: james-d-mitchell

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

@@ -22,8 +22,8 @@ using the :any:`to` function.
 Various uses
 ------------
 
-Recall that the signature for the :any:`to` function is ``to(*args, Return)``.
-In what follows, we explain how different values of *args* and *Return* may be
+Recall that the signature for the :any:`to` function is ``to(*args, rtype)``.
+In what follows, we explain how different values of *args* and *rtype* may be
 used to construct :any:`InversePresentation` objects. The following options are
 possible:
 
@@ -41,7 +41,7 @@ the following values for *args*:
 
     - **p** (:any:`Presentation`) -- the :any:`Presentation` to convert.
 
-Additionally, specify the following for *Return*:
+Additionally, specify the following for *rtype*:
 
     - ``(InversePresentation,)`` for constructing an :any:`InversePresentation`
       over words of the same type as those in *p*.
@@ -92,22 +92,22 @@ specify the following values for *args*:
     - **ip** (:any:`InversePresentation`) -- the :any:`InversePresentation` to
       convert.
 
-Additionally, specify one of the following for *Return*:
+Additionally, specify one of the following for *rtype*:
 
     - ``(InversePresentation, str)`` for constructing an
     - :any:`InversePresentation` over words of type ``str``.
     - ``(InversePresentation, list[int])`` for constructing an
       :any:`InversePresentation` over words of type ``list[int]``.
 
 This function behaves in one of two ways, depending on type of words in *p*, and
-the type of words specified in *Return*:
+the type of words specified in *rtype*:
 
-    1. When the type of words in *ip* and type of words specified in *Return*
+    1. When the type of words in *ip* and type of words specified in *rtype*
        are not the same, this function returns an :any:`InversePresentation`
        equivalent to the input :any:`InversePresentation` *ip* but with words a
        different type (for example, can be used to convert from ``str`` to
        ``list[int]``).
-    2. When the type of words in *ip* and type of words specified in *Return*
+    2. When the type of words in *ip* and type of words specified in *rtype*
        are the same, this function just returns its argument *ip*, and is
        included solely for the purpose of simplifying certain client code, where
        objects of type :any:`InversePresentation` must be converted from one
@@ -120,7 +120,7 @@ of type ``list[int]``, then the conversion from one type to another is
 :math:`a_i \mapsto` ``human_readable_letter(a_i)``.
 
 This function throws a :any:`LibsemigroupsError` if the type of words in *ip* is
-not the same as that specified in *Return* and
+not the same as that specified in *rtype* and
 ``p.throw_if_bad_alphabet_rules_or_inverses()`` throws.
 
 .. seealso::
@@ -164,7 +164,7 @@ using a custom letter conversion function, specify the following values for
     - **f** (``Callable[[str | int], int | str]``) -- the function used to
       convert between the different types of letters.
 
-Additionally, specify one of the following for *Return*:
+Additionally, specify one of the following for *rtype*:
 
     - ``(InversePresentation, str)`` for constructing an
       :any:`InversePresentation` over words of type ``str``.
@@ -180,7 +180,7 @@ to the other.
 This function throws a :any:`LibsemigroupsError` if
 ``ip.throw_if_bad_alphabet_rules_or_inverses()`` throws, or if the function
 specified by *f* does not map letters of the type used in *ip* to letters of the
-type of word specified in *Return*.
+type of word specified in *rtype*.
 
 .. seealso::
 

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

@@ -22,8 +22,8 @@ This page contains documentation relating to converting
 Various uses
 ------------
 
-Recall that the signature for the :any:`to` function is ``to(*args, Return)``.
-In what follows, we explain how different values of *args* and *Return* may be
+Recall that the signature for the :any:`to` function is ``to(*args, rtype)``.
+In what follows, we explain how different values of *args* and *rtype* may be
 used to construct :any:`Presentation` objects. The following options are
 possible:
 
@@ -46,21 +46,21 @@ following values for *args*:
 
     - **p** (:any:`Presentation`) -- the :any:`Presentation` to convert.
 
-Additionally, specify one of the following for *Return*:
+Additionally, specify one of the following for *rtype*:
 
     - ``(Presentation, str)`` for constructing a :any:`Presentation` over words
       of type ``str``.
     - ``(Presentation, list[int])`` for constructing a :any:`Presentation` over
       words of type ``list[int]``.
 
 This function behaves in one of two ways, depending on type of words in *p*, and
-the type of words specified in *Return*:
+the type of words specified in *rtype*:
 
-    1. When the type of words in *p* and type of words specified in *Return* are
+    1. When the type of words in *p* and type of words specified in *rtype* are
        not the same, this function returns a :any:`Presentation` equivalent to
        the input :any:`Presentation` *p* but with words a different type (for
        example, can be used to convert from ``str`` to ``list[int]``).
-    2. When the type of words in *p* and type of words specified in *Return* are
+    2. When the type of words in *p* and type of words specified in *rtype* are
        the same, this function just returns its argument *p*, and is included
        solely for the purpose of simplifying certain client code, where
        presentations must be converted from one type to another sometimes, but
@@ -73,7 +73,7 @@ of type ``list[int]``, then the conversion from one type to another is
 :math:`a_i \mapsto` ``human_readable_letter(a_i)``.
 
 This function throws a :any:`LibsemigroupsError` if the type of words in *p* is
-not the same as that specified in *Return*, and
+not the same as that specified in *rtype*, and
 ``p.throw_if_bad_alphabet_or_rules()`` throws.
 
 .. seealso::
@@ -115,7 +115,7 @@ letter conversion function, specify the following values for *args*:
     - **f** (``Callable[[str | int], int | str]``) -- the function used to
       convert between the different types of letters.
 
-Additionally, specify one of the following for *Return*:
+Additionally, specify one of the following for *rtype*:
 
     - ``(Presentation, str)`` for constructing a :any:`Presentation` over words
       of type ``str``.
@@ -131,7 +131,7 @@ other.
 This function throws a :any:`LibsemigroupsError` if
 ``p.throw_if_bad_alphabet_or_rules()`` throws, or if the function specified by
 *f* does not map letters of the type used in *p* to letters of the type of word
-specified in *Return*.
+specified in *rtype*.
 
 .. seealso::
 
@@ -169,7 +169,7 @@ following values for *args*:
     - **kb** (:any:`KnuthBendix`) -- the :any:`KnuthBendix` from which to obtain
       the rules.
 
-Additionally, specify one of the following for *Return*:
+Additionally, specify one of the following for *rtype*:
 
     - ``(Presentation,)`` for constructing a :any:`Presentation` over words of 
       the same type as that in *kb*.
@@ -211,7 +211,7 @@ enumerates *kb*) prior to calling this function.
     >>> kb.run()
     >>> p2 = to(kb, rtype=(Presentation,))
     >>> for p in [p1, p2]:
-    ...     # Returns whether any changes have been made
+    ...     # rtypes whether any changes have been made
     ...     presentation.sort_each_rule(p)
     ...     presentation.sort_rules(p)
     True
@@ -230,7 +230,7 @@ following values for *args*:
     - **fp** (:any:`FroidurePin`) -- the :any:`FroidurePin` from which to obtain
       the rules.
 
-Additionally, specify the following for *Return*:
+Additionally, specify the following for *rtype*:
 
     - ``(Presentation, str)`` for constructing a :any:`Presentation` over words
       of type ``str``.
@@ -282,7 +282,7 @@ following values for *args*:
     - **k** (:any:`Kambites`) -- the :any:`Kambites` from which to obtain
       the presentation.
 
-Additionally, specify one of the following for *Return*:
+Additionally, specify one of the following for *rtype*:
 
     - ``(Presentation,)`` for constructing a :any:`Presentation` over words of
       the same type as that in *k*.
@@ -342,7 +342,7 @@ following values for *args*:
     - **tc** (:any:`ToddCoxeter`) -- the :any:`ToddCoxeter` from which to obtain
       the presentation.
 
-Additionally, specify one of the following for *Return*:
+Additionally, specify one of the following for *rtype*:
 
     - ``(Presentation,)`` for constructing a :any:`Presentation` over words of
       the same type as that in *tc*.
@@ -402,7 +402,7 @@ following values for *args*:
     - **c** (:any:`Congruence`) -- the :any:`Congruence` from which to obtain
       the presentation.
 
-Additionally, specify one of the following for *Return*:
+Additionally, specify one of the following for *rtype*:
 
     - ``(Presentation,)`` for constructing a :any:`Presentation` over words of
       the same type as that in *c*.
@@ -463,7 +463,7 @@ following values for *args*:
     - **s** (:any:`Stephen`) -- the :any:`Stephen` from which to obtain
       the presentation.
 
-Additionally, specify one of the following for *Return*:
+Additionally, specify one of the following for *rtype*:
 
     - ``(Presentation,)`` for constructing a :any:`Presentation` over words of
       the same type as that in *s*.

docs/source/main-algorithms/froidure-pin/to-froidure-pin.rst

@@ -22,8 +22,8 @@ This page contains documentation relating to converting
 Various uses
 ------------
 
-Recall that the signature for the :any:`to` function is ``to(*args, Return)``.
-In what follows, we explain how different values of *args* and *Return* may be
+Recall that the signature for the :any:`to` function is ``to(*args, rtype)``.
+In what follows, we explain how different values of *args* and *rtype* may be
 used to construct :any:`FroidurePin` objects. The following options are
 possible:
 
@@ -44,7 +44,7 @@ following values for *args*:
     - **cong** (:any:`Congruence`) -- the :any:`Congruence` object being
       converted.
 
-Additionally, specify the following for *Return*:
+Additionally, specify the following for *rtype*:
 
     - ``(FroidurePin,)`` for constructing a :any:`FroidurePin`.
 
@@ -88,7 +88,7 @@ values for *args*:
 
     - **k** (:any:`Kambites`) -- the :any:`Kambites` object being converted.
 
-Additionally, specify the following for *Return*:
+Additionally, specify the following for *rtype*:
 
     - ``(FroidurePin,)`` for constructing a :any:`FroidurePin`.
 
@@ -138,7 +138,7 @@ following values for *args*:
     - **kb** (:any:`KnuthBendix`) -- the :any:`KnuthBendix` object being
       converted.
 
-Additionally, specify the following for *Return*:
+Additionally, specify the following for *rtype*:
 
     - ``(FroidurePin,)`` for constructing a :any:`FroidurePin`.
 
@@ -182,7 +182,7 @@ following values for *args*:
     - **tc** (:any:`ToddCoxeter`) -- the :any:`ToddCoxeter` object being
       converted.
 
-Additionally, specify the following for *Return*:
+Additionally, specify the following for *rtype*:
 
     - ``(FroidurePin,)`` for constructing a :any:`FroidurePin`.
 
@@ -235,7 +235,7 @@ or
     - **last** (:any:`int`) -- the value of :math:`b` in the following
       discussion.
 
-Additionally, specify the following for *Return*:
+Additionally, specify the following for *rtype*:
 
     - ``(FroidurePin,)`` for constructing a :any:`FroidurePin`.
 

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

@@ -22,8 +22,8 @@ This page contains documentation relating to converting
 Various uses
 ------------
 
-Recall that the signature for the :any:`to` function is ``to(*args, Return)``.
-In what follows, we explain how different values of *args* and *Return* may be
+Recall that the signature for the :any:`to` function is ``to(*args, rtype)``.
+In what follows, we explain how different values of *args* and *rtype* may be
 used to construct :any:`KnuthBendix` objects. The following options are
 possible:
 
@@ -44,7 +44,7 @@ rewriter, specify all of the following values for *args*:
     - **tc** (:any:`ToddCoxeter`) -- the :any:`ToddCoxeter` object being
       converted.
 
-Additionally, specify the following for *Return*:
+Additionally, specify the following for *rtype*:
 
     - ``(KnuthBendix,)`` for constructing a :any:`KnuthBendix` with the default
       rewriter.
@@ -97,7 +97,7 @@ following values for *args*:
     - **tc** (:any:`ToddCoxeter`) -- the :any:`ToddCoxeter` object being
       converted.
 
-Additionally, specify one of the following for *Return*:
+Additionally, specify one of the following for *rtype*:
 
     - ``(KnuthBendix, 'RewriteTrie')`` for constructing a :any:`KnuthBendix`
       with the the ``RewriteTrie'`` rewriter.
@@ -152,7 +152,7 @@ following values for *args*:
     - **fpb** (:any:`FroidurePin`) -- the :any:`FroidurePin` object being
       converted.
 
-Additionally, specify one of the following for *Return*:
+Additionally, specify one of the following for *rtype*:
 
     - ``(KnuthBendix, str, 'RewriteTrie')`` for constructing a
       :any:`KnuthBendix` on words with type ``str`` using the ``RewriteTrie'``

docs/source/main-algorithms/todd-coxeter/to-todd-coxeter.rst

@@ -22,8 +22,8 @@ This page contains documentation relating to converting
 Various uses
 ------------
 
-Recall that the signature for the :any:`to` function is ``to(*args, Return)``.
-In what follows, we explain how different values of *args* and *Return* may be
+Recall that the signature for the :any:`to` function is ``to(*args, rtype)``.
+In what follows, we explain how different values of *args* and *rtype* may be
 used to construct :any:`ToddCoxeter` objects. The following options are
 possible:
 
@@ -44,7 +44,7 @@ following values for *args*:
       converted; and
     - **wg** (:any:`WordGraph`) -- the left or right Cayley graph of *fpb*.
 
-Additionally, specify one of the following for *Return*:
+Additionally, specify one of the following for *rtype*:
 
     - ``(ToddCoxeter, str)`` for constructing a :any:`ToddCoxeter` on words with
       type ``str``.
@@ -103,7 +103,7 @@ following values for *args*:
     - **kb** (:any:`KnuthBendix`) -- the :any:`KnuthBendix` object being
       converted.
 
-Additionally, specify the following for *Return*:
+Additionally, specify the following for *rtype*:
 
     - ``(ToddCoxeter,)`` for constructing a :any:`ToddCoxeter`.