Mention the calc module in the operator list (#5595)

This commit is contained in:
Malo 2024-12-18 14:37:32 +01:00 committed by GitHub
parent 05559a6638
commit 24c08a7ec0
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 5 additions and 2 deletions

View File

@ -992,7 +992,7 @@ pub fn div_euclid(
/// #calc.rem-euclid(1.75, 0.5) \
/// #calc.rem-euclid(decimal("1.75"), decimal("0.5"))
/// ```
#[func(title = "Euclidean Remainder")]
#[func(title = "Euclidean Remainder", keywords = ["modulo", "modulus"])]
pub fn rem_euclid(
/// The callsite span.
span: Span,

View File

@ -340,7 +340,10 @@ packages. For more details on this, see the
## Operators
The following table lists all available unary and binary operators with effect,
arity (unary, binary) and precedence level (higher binds stronger).
arity (unary, binary) and precedence level (higher binds stronger). Some
operations, such as [modulus]($calc.rem-euclid), do not have a special syntax
and can be achieved using functions from the
[`calc`]($category/foundations/calc) module.
| Operator | Effect | Arity | Precedence |
|:----------:|---------------------------------|:------:|:----------:|