Skip to content

Expose Runner/Reporter/delta #279

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Joseph-Edwards merged 4 commits into from
Jun 17, 2025
Merged

Expose Runner/Reporter/delta #279

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
52993d6
Expose Runner/Reporter/delta
james-d-mitchell Jun 17, 2025
ebeef65
Fix currentmodule
james-d-mitchell Jun 17, 2025
1417014
Code review changes
james-d-mitchell Jun 17, 2025
04d8ca9
Update docs/source/main-algorithms/core-classes/delta.rst
james-d-mitchell Jun 17, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions docs/source/main-algorithms/core-classes/delta.rst
View file
Open in desktop
Comment thread
james-d-mitchell marked this conversation as resolved.
Original file line number Diff line number Diff line change
@@ -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
Comment thread
james-d-mitchell marked this conversation as resolved.

The delta function
==================

This page contains the documentation for the :py:func:`delta` function.

.. autofunction:: delta
3 changes: 2 additions & 1 deletion docs/source/main-algorithms/core-classes/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ pages.
.. toctree::
:maxdepth: 1

delta
reporter
report-guard
runner
runner
2 changes: 1 addition & 1 deletion docs/source/main-algorithms/core-classes/reporter.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
==================
Expand Down
2 changes: 1 addition & 1 deletion docs/source/main-algorithms/core-classes/runner.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
================
Expand Down
3 changes: 3 additions & 0 deletions src/libsemigroups_pybind11/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,8 @@
Paths,
PositiveInfinity,
ReportGuard,
Reporter,
Runner,
StringRange,
ToString,
ToWord,
Expand All @@ -79,6 +81,7 @@
WordGraph,
WordRange,
congruence_kind,
delta,
error_message_with_prefix,
freeband_equal_to,
lexicographical_compare,
Expand Down
5 changes: 1 addition & 4 deletions tests/test_runner.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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():
Expand Down
3 changes: 3 additions & 0 deletions tests/test_to.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Comment thread
james-d-mitchell marked this conversation as resolved.
Expand Down