Skip to content

Bugfix/no ref/correct constrain documentation #108

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

Closed
wants to merge 2 commits into from
Closed

Bugfix/no ref/correct constrain documentation #108

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
095a0f0
fix: corrected the inversion between maximum and minimum for low and …
JulienBacquart Feb 5, 2024
3c379f9
fix: improved the description of the constrain() function
JulienBacquart Feb 5, 2024
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
8 changes: 4 additions & 4 deletions reference/sketch_constrain.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# constrain()

Constrains a value to not exceed a maximum and minimum value.
Constrains a value between a minimum and maximum value.

## Examples

Expand All @@ -23,15 +23,15 @@ def draw():

## Description

Constrains a value to not exceed a maximum and minimum value.
Restrict the input value to a specified range defined by a minimum and a maximum limit.

## Signatures

```python
constrain(
amt: Union[float, npt.NDArray], # the value to constrain
low: Union[float, npt.NDArray], # maximum limit
high: Union[float, npt.NDArray], # minimum limit
low: Union[float, npt.NDArray], # minimum limit
high: Union[float, npt.NDArray], # maximum limit
) -> Union[float, npt.NDArray]
```

Expand Down