Skip to content

Commit 1e44a97

Browse files
Update description in doc
1 parent f3e581c commit 1e44a97

1 file changed

Lines changed: 6 additions & 9 deletions

File tree

src/errors.cpp

Lines changed: 6 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -55,9 +55,6 @@ namespace libsemigroups {
5555
}
5656

5757
void init_error(py::module& m) {
58-
// TODO this doesn't seem to properly catch all LibsemigroupsExceptions,
59-
// particularly on macOS. This may have been resolved in pybind11 2.12.0
60-
6158
// Using the GIL safe call below rather than simply having a static
6259
// py::exception is recommended in the pybind11 doc.
6360
PYBIND11_CONSTINIT static py::gil_safe_call_once_and_store<py::object>
@@ -84,9 +81,9 @@ Return whether :any:`LibsemigroupsError` messages have a C++ prefix.
8481
8582
Since ``libsemigroups_pybind11`` is built on top of the C++ library
8683
``libsemigroups``, many of the errors thrown in ``libsemigroups_pybind11``
87-
emanate from a C++ function. This function returns whether
88-
:any:`LibsemigroupsError` messages contain a prefix that indicates which C++
89-
function raised the exception.
84+
emanate from C++. This function returns whether :any:`LibsemigroupsError`
85+
messages contain a prefix that indicates which C++ function raised the
86+
exception.
9087
9188
:return: Whether :any:`LibsemigroupsError` messages contain a prefix about the
9289
C++ function that raised the exception.
@@ -100,9 +97,9 @@ Specify whether :any:`LibsemigroupsError` messages have a C++ prefix.
10097
10198
Since ``libsemigroups_pybind11`` is built on top of the C++ library
10299
``libsemigroups``, many of the errors thrown in ``libsemigroups_pybind11``
103-
emanate from a C++ function. This function specifies whether
104-
:any:`LibsemigroupsError` messages should contain a prefix that indicates which
105-
C++ function raised the exception. By default, this information is not included.
100+
emanate from C++. This function specifies whether :any:`LibsemigroupsError`
101+
messages should contain a prefix that indicates which C++ function raised the
102+
exception. By default, this information is not included.
106103
107104
:param val: Whether :any:`LibsemigroupsError` messages should contain a prefix
108105
about the C++ function that raised the exception.

0 commit comments

Comments
 (0)