Skip to content

Commit 5020970

Browse files
Action renovated!
1 parent 302cb3d commit 5020970

File tree

3 files changed

+7
-4
lines changed

3 files changed

+7
-4
lines changed

docs/source/_ext/libsemigroups_pybind11_extensions.py

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -104,7 +104,6 @@ def no_doc_run(self):
104104
r"libsemigroups::Sims2": r"Sims2",
105105
r"libsemigroups::RepOrc": r"RepOrc",
106106
r"libsemigroups::MinimalRepOrc": r"MinimalRepOrc",
107-
r"libsemigroups::BooleanOne, int>": r"Matrix",
108107
}
109108

110109
# This dictionary should be of the form class_name -> (pattern, repl), where
@@ -141,7 +140,7 @@ def no_doc_run(self):
141140
# FIXME can't disable signatures in c++ for the next one because it is
142141
# overloaded, and then there are no signatures at all (and the overloads
143142
# are seemingly documented as a single function because of this)
144-
# r"knuth_bendix_non_trivial_classes.*$": "",
143+
r"knuth_bendix_non_trivial_classes.*$": "",
145144
r"pbr_one\(\*args, \*\*kwargs\)": "",
146145
r"word_graph_dot\(.*\)(\s*->\s*(\w+::)*\w*)?": "",
147146
}

libsemigroups_pybind11/action.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -189,7 +189,7 @@ def __init__(
189189
* **generators** (*List[Element]*)-- at least one generator for the action.
190190
* **seeds** (*List[Point]*) -- at least one seed point for the action.
191191
* **func** (*Callable[[Point, Element], Point]*) -- the function defining the action.
192-
* **side** (:any:`side <side>`)-- the side of the action.
192+
* **side** (:py:class:`side <side>`)-- the side of the action.
193193
194194
:raises TypeError:
195195
if *generators* or *seeds* is not a list.

src/kambites.cpp

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -73,8 +73,12 @@ included for uniformity of interface between with
7373
def_construct_kind_presentation(
7474
thing, "Kambites", doc{.detail = extra_detail});
7575

76+
// FIXME the following doesn't get included in the doc for some reason.
77+
// This is probably a problem in libsemigroups_pybind11_extensions.py,
78+
// since introducing an error in the string below goes yield a
79+
// warning/error in sphinx.
7680
auto extra_raises = R"pbdoc(
77-
:raises LibsemigroupsError: if *knd* is not :any:`congruence_kind.twosided`.
81+
:raises LibsemigroupsError: if *knd* is not ``congruence_kind.twosided``.
7882
)pbdoc"sv;
7983

8084
def_init_kind_presentation(

0 commit comments

Comments
 (0)