File tree Expand file tree Collapse file tree 1 file changed +13
-4
lines changed Expand file tree Collapse file tree 1 file changed +13
-4
lines changed Original file line number Diff line number Diff line change @@ -42,9 +42,18 @@ namespace libsemigroups {
42
42
using FroidurePin_ = FroidurePin<Element>;
43
43
44
44
std::string pyclass_name = std::string (" FroidurePin" ) + name;
45
- py::class_<FroidurePin_, FroidurePinBase> thing (m,
46
- pyclass_name.c_str (),
47
- R"pbdoc(
45
+ py::class_<FroidurePin_, FroidurePinBase> thing (
46
+ m,
47
+ pyclass_name.c_str (),
48
+ // To change the top-level signature of a class, :sig=...: should be
49
+ // specified here in the class docstring. This is most likely the
50
+ // desired behaiour if a constructor is not overloaded.
51
+ // If the constructor is overloaded and the signature of an individual
52
+ // overload is to be changed, :sig=...: should be specified in the
53
+ // docstring of that py::init function.
54
+ R"pbdoc(
55
+ :sig=(self: FroidurePin, gens: List[Element]) -> None:
56
+
48
57
Class implementing the Froidure-Pin algorithm.
49
58
50
59
A :any:`FroidurePin` instance represents a semigroup or monoid defined by a
@@ -935,7 +944,7 @@ This function returns the element of *fp* obtained by evaluating *w*.
935
944
}
936
945
// TODO(1) are there some functions missing here?
937
946
} // bind_froidure_pin
938
- } // namespace
947
+ } // namespace
939
948
940
949
void init_froidure_pin (py::module & m) {
941
950
// TODO(0) uncomment bind_froidure_pin<HPCombiTransf<16>>(m, "Transf16");
You can’t perform that action at this time.
0 commit comments