Zulip Chat Archive

Stream: new members

Topic: Update docs for ordered mixins


Peter Hansen (Jan 22 2026 at 10:24):

I have noticed that several docstrings in mathlib still describe the semibundled
Ordered* classes (e.g. OrderedSemiring, LinearOrderedField) even though they were deprecated almost a year ago and replaced with mixins like docs#IsOrderedAddMonoid and docs#IsOrderedRing.

The dated references occur in several files, but it seems especially noticeable in the former core
files for the deprecated classes:

I am considering a documentation-only PR to update the module docstrings and typeclass descriptions
to reference the new mixins. For

it seems to just need replacing the suggested "less granular typeclasses" from their deprecated
versions to the new ones. The files

contain almost identical docstrings. They list the ten deprecated Ordered* classes for rings and
then explain a hierarchy among them. With the current mixins, we only have two classes:
docs#IsOrderedRing and docs#IsStrictOrderedRing. I am not entirely sure what the best replacement is.
Should we replace the hierarchy section with a short explanation of how these mixins interact with
the different ring and order assumptions?

I am a relatively new contributor and have not written documentation before, but I would like to
take a stab at it unless this is something that should generally be left to maintainers.

Ruben Van de Velde (Jan 22 2026 at 10:31):

Thanks for flagging this; if you want to take a stab at updating the docs, that would be very welcome


Last updated: Feb 28 2026 at 14:05 UTC