Skip to content

Commit 2eb0ffa

Browse files
Joseph-Edwardsjames-d-mitchell
authored andcommitted
Doc: Add page for ReportGuard
1 parent d12d4e8 commit 2eb0ffa

3 files changed

Lines changed: 26 additions & 2 deletions

File tree

docs/source/main-algorithms/core-classes/index.rst

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,10 +14,12 @@ desirable to report the state of the algorithm. Therefore, the classes
1414
:any:`Runner` and :any:`Reporter` exist to provide common functions to many
1515
classes that implement the main algorithms.
1616

17-
Documentation for these classes can be found on the following pages.
17+
Documentation for these, and associated, classes can be found on the following
18+
pages.
1819

1920
.. toctree::
2021
:maxdepth: 1
2122

2223
reporter
24+
report-guard
2325
runner
Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
..
2+
Copyright (c) 2025, Joseph Edwards
3+
4+
Distributed under the terms of the GPL license version 3.
5+
6+
The full license is in the file LICENSE, distributed with this software.
7+
8+
.. currentmodule:: libsemigroups_pybind11
9+
10+
The ReportGuard class
11+
=======================
12+
13+
.. autoclass:: ReportGuard
14+
:doc-only:
15+
:class-doc-from: class
16+
17+
Full API
18+
--------
19+
20+
.. autoclass:: ReportGuard
21+
:members:
22+
:class-doc-from: init

src/report.cpp

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ namespace libsemigroups {
3333
R"pbdoc(
3434
Objects of this type can be used to enable printing of some information
3535
during various of the computation in ``libsemigroups_pybind11``. Reporting
36-
is enable (or not) at construction time, and disable when the
36+
is enabled (or not) at construction time, and disable when the
3737
:py:class:`ReportGuard` goes out of scope.
3838
)pbdoc")
3939
.def(py::init<bool>(),

0 commit comments

Comments
 (0)