Doc Update #788
Merged
Doc Update #788
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: Erik Jaegervall <[email protected]>
| `min` | The minimum value, within the interval of the given `datatype`, that the data entry can be assigned. If omitted, the minimum value will be the "Min" value for the given datatype. Cannot be specified if `allowed` is defined for the same data entry. | ||
| `max` | The maximum value, within the interval of the given `datatype`, that the data entry can be assigned. If omitted, the maximum value will be the "Max" value for the given datatype. Cannot be specified if `allowed` is defined for the same data entry. | ||
| `unit` | The unit of measurement that the data entry has. See [Data Units](/vehicle_signal_specification/rule_set/data_entry/data_units/) chapter for a list of available units. Cannot be specified if `allowed` is defined for the same data entry. | ||
| `pattern` | Can be used for datatype `string` to specify a regular expression that limits allowed values for the data entry. The expression must be supported by [Python Regular Expressions](https://docs.python.org/3/howto/regex.html) | *since version 6.0* |
There was a problem hiding this comment.
Would it worth if we say that patterns can be used for string and string[] or it can be assumed that after one type is allowed, then its plural (array) version is also allowed?
Other than this, I checked the online test link, you provided: https://erikbosch.github.io/vehicle_signal_specification/rule_set/data_entry/sensor_actuator/index.html and this part is OK for me.
There was a problem hiding this comment.
Makes sense to mention also [], will update
Signed-off-by: Erik Jaegervall <[email protected]>
|
MoM:
|
Kostadin-Ivanov
approved these changes
Nov 6, 2024
|
MoM: Ok to merge |
Kostadin-Ivanov
approved these changes
Nov 12, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR contain various documentation updates, the significant being:
patternattributedefaultfor structs, so it is clear that it is allowed and including a few examplesFor a live version visit https://erikbosch.github.io/vehicle_signal_specification/