Skip to content

Commit

Permalink
More doc fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
james-d-mitchell committed Apr 15, 2024
1 parent 5568ff9 commit 385958b
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 12 deletions.
8 changes: 2 additions & 6 deletions docs/source/action.rst
Original file line number Diff line number Diff line change
Expand Up @@ -92,10 +92,6 @@ RightAction Methods
-------------------
.. autoclass:: RowActionBMat8
:no-undoc-members:
:exclude-members: __init__
:members:

Runner Methods
--------------
.. autoclass:: RowActionBMat8
:noindex:
:inherited-members:
:inherited-members:
10 changes: 4 additions & 6 deletions src/action.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -26,12 +26,10 @@
// libsemigroups headers
#include <libsemigroups/action.hpp>
#include <libsemigroups/bmat8.hpp>
// action complete or delete

// pybind11....
#include <pybind11/pybind11.h>
#include <pybind11/stl.h>
// action complete or delete

// libsemigroups_pybind11....
#include "main.hpp" // for init_action
Expand Down Expand Up @@ -157,7 +155,7 @@ Checks if the RowActionBMat8 contains any points.
&Action_::at,
py::arg("pos"),
R"pbdoc(
Returns a const reference to the point in a given position.
Returns the point in a given position.
:param pos: the index of an element.
:type pos: int
Expand Down Expand Up @@ -300,10 +298,10 @@ of the strongly connected component containing ``at(pos)``.
},
py::arg("x"),
R"pbdoc(
Returns a const reference to the root point of a strongly connected component.
Returns the root point of a strongly connected component.
:param x: the point whose root we want to find.
:type x: const_reference_point_type
:type x: point
:complexity:
At most :math:`O(mn)` where :math:`m` is the complexity of multiplying elements
Expand Down Expand Up @@ -356,7 +354,7 @@ Returns the word graph of the completely enumerated action.
.def("scc",
&Action_::scc,
R"pbdoc(
Returns a reference to a Gabow object for strongly connected components.
Returns a Gabow object for strongly connected components.
:complexity:
At most :math:`O(mn)` where :math:`m` is the complexity of
Expand Down

0 comments on commit 385958b

Please sign in to comment.