Skip to content

Commit

Permalink
Update allowed.md (COVESA#565)
Browse files Browse the repository at this point in the history
* Update allowed.md

Improve clarity of example by introducing a value that is easily recognized as not belonging in the 'allowed' list.

Signed-off-by: Neil Puthuff <neil@rti.com>
  • Loading branch information
neil-rti authored and jdacoello committed May 2, 2023
1 parent 6ede501 commit 306b518
Showing 1 changed file with 7 additions and 7 deletions.
14 changes: 7 additions & 7 deletions docs-gen/content/rule_set/data_entry/allowed.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,25 +47,25 @@ The actual value of the signal is expected to contain a subset of the values spe
Example:

```YAML
FavoriteColors:
DogBreeds:
datatype: string[]
type: attribute
allowed: ['RED', 'GREEN', 'BLUE', 'YELLOW', 'BROWN']
description: Driver's favorite colors.
allowed: ['AKITA', 'BOXER', 'DACHSHUND', 'PAPILLON', 'PUG', 'VIZSLA']
description: Brief list of dog breeds.
```
Examples of valid arrays:
```
[] # Empty array
['RED']
['YELLOW', 'BROWN', 'RED', 'GREEN', 'BLUE']
['BLUE', 'BLUE'] # duplication is allowed
['BOXER']
['PAPILLON', 'VIZSLA', 'BOXER', 'AKITA', 'DACHSHUND']
['PUG', 'PUG'] # duplication is allowed
```


Example of an invalid array:

```
['RED', 'BLUE', 'BLACK'] # BLACK is not an allowed value
['PAPILLON', 'VIZSLA', 'LOBSTER'] # LOBSTER is not in the allowed value list
```

0 comments on commit 306b518

Please sign in to comment.