Add documentation for delete argument #763
Merged
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
docs-gen/content/rule_set/overlay.md
Outdated
| @@ -114,6 +115,39 @@ Vehicle.Occupant.Row1.DriverSide.HeadPosition.Yaw: | |||
| unit: mm | |||
| ``` | |||
|
|
|||
| ### Deleting nodes | |||
|
|
|||
| It is possible to delete nodes using the `delete` atrribute. | |||
docs-gen/content/rule_set/overlay.md
Outdated
| delete: true | ||
| ``` | ||
|
|
||
| When using the `delete` argument vss-tools will print information on nodes removed. |
There was a problem hiding this comment.
The output changes with COVESA/vss-tools#382
Signed-off-by: Erik Jaegervall <[email protected]>
erikbosch
force-pushed
the
erik_delete
branch
from
e48a485
to
4504257
Compare
sschleemilch
approved these changes
Sep 2, 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.
I noticed that we did not add any documentation on the
deleteargument added some months ago in vss-tools. This is an attempt for a short documentation.We can discuss if we also should mention it in the syntax, and not only as an overlay example.