Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

#

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Mark deprecated rsl method and propose alternative in the docs. #102

Merged
merged 1 commit into from
Apr 12, 2023
Merged

Mark deprecated rsl method and propose alternative in the docs. #102

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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 README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -216,16 +216,16 @@ Some of these validators work only on value types, some on string types, and oth
The built-in validator functions provided by this package are:

**Value validators**
| Function | Arguments | Description |
|------------------------|---------------------|--------------------------------------|
| bounds<> | [lower, upper] | Bounds checking (inclusive) |
| lower_bounds<> | [lower] | Lower bounds (inclusive) |
| upper_bounds<> | [upper] | Upper bounds (inclusive) |
| lt<> | [value] | parameter < value |
| gt<> | [value] | parameter > value |
| lt_eq<> | [value] | parameter <= value (upper_bounds) |
| gt_eq<> | [value] | parameter >= value (lower_bounds) |
| one_of<> | [[val1, val2, ...]] | Value is one of the specified values |
| Function | Arguments | Description |
|------------------------|---------------------|---------------------------------------|
| bounds<> | [lower, upper] | Bounds checking (inclusive) |
| lower_bounds<> | [lower] | Lower bounds [Deprecated, use `gt_eq`]|
| upper_bounds<> | [upper] | Upper bounds [Deprecated, use `lt_eq`]|
| lt<> | [value] | parameter < value |
| gt<> | [value] | parameter > value |
| lt_eq<> | [value] | parameter <= value (upper_bounds) |
| gt_eq<> | [value] | parameter >= value (lower_bounds) |
| one_of<> | [[val1, val2, ...]] | Value is one of the specified values |

**String validators**
| Function | Arguments | Description |
Expand Down
2 changes: 1 addition & 1 deletion example/src/parameters.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ admittance_controller:
default_value: 1.0,
description: "proportional gain term",
validation: {
lower_bounds<>: [ 0 ],
gt_eq<>: [ 0 ],
}
}
i: {
Expand Down
2 changes: 1 addition & 1 deletion generate_parameter_library_py/generate_parameter_library_py/test/valid_parameters.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ admittance_controller:
default_value: 1.0,
description: "proportional gain term",
validation: {
lower_bounds<>: [ 0 ],
gt_eq<>: [ 0 ],
}
}
i: {
Expand Down