diff --git a/docs/source/main-algorithms/core-classes/delta.rst b/docs/source/main-algorithms/core-classes/delta.rst new file mode 100644 index 000000000..1986cd2f0 --- /dev/null +++ b/docs/source/main-algorithms/core-classes/delta.rst @@ -0,0 +1,15 @@ +.. + Copyright (c) 2025 Joseph Edwards + + Distributed under the terms of the GPL license version 3. + + The full license is in the file LICENSE, distributed with this software. + +.. currentmodule:: _libsemigroups_pybind11 + +The delta function +================== + +This page contains the documentation for the :py:func:`delta` function. + +.. autofunction:: delta diff --git a/docs/source/main-algorithms/core-classes/index.rst b/docs/source/main-algorithms/core-classes/index.rst index b382814b9..519644294 100644 --- a/docs/source/main-algorithms/core-classes/index.rst +++ b/docs/source/main-algorithms/core-classes/index.rst @@ -20,6 +20,7 @@ pages. .. toctree:: :maxdepth: 1 + delta reporter report-guard - runner \ No newline at end of file + runner diff --git a/docs/source/main-algorithms/core-classes/reporter.rst b/docs/source/main-algorithms/core-classes/reporter.rst index a776ffb3c..6d6ef29cc 100644 --- a/docs/source/main-algorithms/core-classes/reporter.rst +++ b/docs/source/main-algorithms/core-classes/reporter.rst @@ -5,7 +5,7 @@ The full license is in the file LICENSE, distributed with this software. -.. currentmodule:: _libsemigroups_pybind11 +.. currentmodule:: libsemigroups_pybind11 The Reporter class ================== diff --git a/docs/source/main-algorithms/core-classes/runner.rst b/docs/source/main-algorithms/core-classes/runner.rst index d92ed05db..ccb865a7d 100644 --- a/docs/source/main-algorithms/core-classes/runner.rst +++ b/docs/source/main-algorithms/core-classes/runner.rst @@ -5,7 +5,7 @@ The full license is in the file LICENSE, distributed with this software. -.. currentmodule:: _libsemigroups_pybind11 +.. currentmodule:: libsemigroups_pybind11 The Runner class ================ diff --git a/src/libsemigroups_pybind11/__init__.py b/src/libsemigroups_pybind11/__init__.py index 387639460..5ad2f9f6d 100644 --- a/src/libsemigroups_pybind11/__init__.py +++ b/src/libsemigroups_pybind11/__init__.py @@ -70,6 +70,8 @@ Paths, PositiveInfinity, ReportGuard, + Reporter, + Runner, StringRange, ToString, ToWord, @@ -79,6 +81,7 @@ WordGraph, WordRange, congruence_kind, + delta, error_message_with_prefix, freeband_equal_to, lexicographical_compare, diff --git a/tests/test_runner.py b/tests/test_runner.py index 373af7606..133ad5674 100644 --- a/tests/test_runner.py +++ b/tests/test_runner.py @@ -13,10 +13,7 @@ from datetime import timedelta -from _libsemigroups_pybind11 import ( # pylint: disable=no-name-in-module - Reporter, - delta, -) +from libsemigroups_pybind11 import Reporter, delta def test_reporter_000(): diff --git a/tests/test_to.py b/tests/test_to.py index 8dd07f252..f1e05a504 100644 --- a/tests/test_to.py +++ b/tests/test_to.py @@ -12,6 +12,9 @@ """ import pytest + +# TODO(1) be good to remove the imports from _libsemigroups_pybind11, but +# couldn't immediately figure out how to. from _libsemigroups_pybind11 import ( FroidurePinKBEStringRewriteFromLeft, FroidurePinKBEStringRewriteTrie,