Skip to content

Add order alphabet doc #471

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

Open
james-d-mitchell wants to merge 3 commits into
base: main
Choose a base branch
from
+200 −110
Open

Add order alphabet doc #471

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
b734f15
order: remove doc for deprecated functions
james-d-mitchell Aug 14, 2026
211c4e7
order: add doc for Alphabet aware orders, and cleanup
codex Aug 14, 2026
4d2fca7
order: remove no longer used doc
james-d-mitchell Aug 14, 2026
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
20 changes: 10 additions & 10 deletions docs/source/data-structures/order/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,16 @@ or strings with respect to certain reduction orderings.

.. seealso::

:any:`Order`.
- :any:`Order`
- :any:`Alphabet`

.. important::

The following functions are deprecated in v1.5.0 and will be removed v2.0.0:

* ``lexicographical_compare``, please use :any:`lex_cmp` instead.
* ``recursive_path_compare`` please use :any:`rev_rpo_cmp` instead.
* ``shortlex_compare`` please use :any:`lenlex_cmp` instead.

Contents
--------
Expand All @@ -25,11 +34,8 @@ Contents

lenlex_cmp
lex_cmp
lexicographical_compare
recursive_path_compare
rev_rpo_cmp
rpo_cmp
shortlex_compare

Full API
--------
Expand All @@ -38,12 +44,6 @@ Full API

.. autofunction:: lex_cmp

.. autofunction:: lexicographical_compare

.. autofunction:: recursive_path_compare

.. autofunction:: rev_rpo_cmp

.. autofunction:: rpo_cmp

.. autofunction:: shortlex_compare
Loading
Loading