Skip to content
Open
Changes from all commits
Commits
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
7 changes: 6 additions & 1 deletion templates/contribute/naming.md
Original file line number Diff line number Diff line change
Expand Up @@ -525,13 +525,18 @@ and "let $G$ be a group and let $H$ be a normal subgroup" is written
and `Normal H` are not extra data, but are extra assumptions on data we have already.

Mathlib currently strives towards the following naming convention for these `Prop`-valued
classes. If the class is a noun then its name should begin with `Is`. If however is it an adjective
classes. If the class is a noun (or noun phrase) then its name should begin with `Is`. If however is it an adjective
then its name does not need to begin with an `Is`. So for example `IsNormal` would be acceptable
for the "normal subgroup" typeclass, but `Normal` is also fine; we might say "assume the subgroup
`H` is normal" in informal language. However `IsTopologicalRing` is
preferred for the "topological ring" typeclass, as we do not say "assume the ring `R` is
topological" informally.

If the predicate is referring to data other than the explicit argument,
then the prefix `Has` may be used instead of the prefix `Is`, if that sounds more natural.
Examples: `Filter.HasBasis`, `Function.HasLeftInverse`, `HasLimit` (for a functor in category theory),
`HasCompactSupport` (`IsCompactlySupportedFunction` would also follow this naming scheme, but is very long).

### Unexpanded and expanded forms of functions

The multiplication of two functions `f` and `g` can be denoted equivalently as
Expand Down
Loading