Skip to content

Commit c91f44b

Browse files
Minor doc tweaks
1 parent 7b10269 commit c91f44b

1 file changed

Lines changed: 34 additions & 10 deletions

File tree

src/konieczny.cpp

Lines changed: 34 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -61,8 +61,18 @@ the size, partial order of :math:`\mathscr{D}`-classes, and frames for each
6161
});
6262
thing.def("__copy__",
6363
[](Konieczny_ const& self) { return Konieczny_(self); });
64-
thing.def("copy",
65-
[](Konieczny_ const& self) { return Konieczny_(self); });
64+
thing.def(
65+
"copy",
66+
[](Konieczny_ const& self) { return Konieczny_(self); },
67+
R"pbdoc(
68+
Copy a Konieczny.
69+
70+
:param other: the Konieczny to copy.
71+
:type other: Konieczny
72+
73+
:returns: A copy of the argument.
74+
:rtype: Konieczny
75+
)pbdoc");
6676

6777
thing.def(py::init<>(), R"pbdoc(
6878
Default constructor. This is the standard constructor for a :any:`KoniecznyBMat8`
@@ -135,15 +145,19 @@ See :any:`KoniecznyBMat8.add_generator` for a detailed description.
135145
self.cend_current_D_classes());
136146
},
137147
R"pbdoc(
138-
Returns an iterator yielding the :math:`\mathscr{D}`-classes. This function
139-
does not trigger any enumeration; the iterator returned may be invalidated
140-
by any call to a non-const member function of the :any:`KoniecznyBMat8` class.
148+
:sig=(self: KoniecznyBMat8) -> Iterator[KoniecznyBMat8DClass]:
149+
150+
Returns an iterator yielding the :math:`\mathscr{D}`-classes.
151+
152+
This function does not trigger any enumeration; the iterator returned may be
153+
invalidated by any call to a non-const member function of the
154+
:any:`KoniecznyBMat8` class.
141155
142156
:returns:
143157
An iterator.
144158
145159
:rtype:
146-
Iterator
160+
Iterator[KoniecznyBMat8DClass]
147161
)pbdoc");
148162
thing.def(
149163
"D_classes",
@@ -153,14 +167,16 @@ by any call to a non-const member function of the :any:`KoniecznyBMat8` class.
153167
self.cend_D_classes());
154168
},
155169
R"pbdoc(
170+
:sig=(self: KoniecznyBMat8) -> Iterator[KoniecznyBMat8DClass]:
171+
156172
Returns an iterator yielding the :math:`\mathscr{D}`-classes of a
157173
:any:`KoniecznyBMat8` object. This function triggers a full enumeration.
158174
159175
:returns:
160176
An iterator yielding :math:`\mathscr{D}`-classes.
161177
162178
:rtype:
163-
Iterator
179+
Iterator[KoniecznyBMat8DClass]
164180
)pbdoc");
165181
thing.def(
166182
"generators",
@@ -169,14 +185,16 @@ Returns an iterator yielding the :math:`\mathscr{D}`-classes of a
169185
self.cend_generators());
170186
},
171187
R"pbdoc(
188+
:sig=(self: KoniecznyBMat8) -> Iterator[KoniecznyBMat8DClass]:
189+
172190
Returns an iterator yielding the generators of a :any:`KoniecznyBMat8` object.
173191
This function does not trigger any enumeration; the iterator returned may be
174192
invalidated by any call to a non-const member function of the
175193
:any:`KoniecznyBMat8` class.
176194
177195
:returns:
178196
An iterator yielding the generators.
179-
:rtype: Iterator
197+
:rtype: Iterator[KoniecznyBMat8DClass]
180198
)pbdoc");
181199
thing.def(
182200
"current_regular_D_classes",
@@ -185,14 +203,16 @@ invalidated by any call to a non-const member function of the
185203
self.cend_current_regular_D_classes());
186204
},
187205
R"pbdoc(
206+
:sig=(self: KoniecznyBMat8) -> Iterator[KoniecznyBMat8DClass]:
207+
188208
Returns an iterator yielding the so-far enumerated regular
189209
:math:`\mathscr{D}`-classes of a :any:`KoniecznyBMat8` object. This function
190210
does not trigger any enumeration; the iterator returned may be invalidated by
191211
any call to a non-const member function of the :any:`KoniecznyBMat8` class.
192212
193213
:returns:
194214
An iterator yielding regular :math:`\mathscr{D}`-classes.
195-
:rtype: Iterator
215+
:rtype: Iterator[KoniecznyBMat8DClass]
196216
)pbdoc");
197217
thing.def("contains",
198218
&Konieczny_::contains,
@@ -316,13 +336,15 @@ Returns the current size.
316336
typename Konieczny_::DClass& { return self.D_class_of_element(x); },
317337
py::arg("x"),
318338
R"pbdoc(
339+
:sig=(self: KoniecznyBMat8, x: Element) -> KoniecznyBMat8DClass:
340+
319341
Returns the :math:`\mathscr{D}`-class containing an element.
320342
321343
:param x: a possible element.
322344
:type x: Element
323345
324346
:returns: The :any:`DClass` containing *x*.
325-
:rtype: KoniecznyBMat8.DClass
347+
:rtype: KoniecznyBMat8DClass
326348
327349
:raises LibsemigroupsError: if *x* does not belong to *self*.
328350
)pbdoc",
@@ -495,6 +517,8 @@ This function triggers a full enumeration.
495517
m,
496518
(actual_name + "DClass").c_str(),
497519
R"pbdoc(
520+
Abstract class that represents a :math:`\mathscr{D}`-class.
521+
498522
The nested abstract class :any:`DClass` represents a :math:`\mathscr{D}`-class
499523
via a frame as computed in Konieczny's algorithm; see :cite:`Konieczny1994aa`
500524
for more details. As an abstract class, :any:`DClass` cannot be directly

0 commit comments

Comments
 (0)