Skip to content
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.

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

Overlay annotations to indicate if a signal is supposed to already exist or not. #227

Open
erikbosch opened this issue Feb 9, 2023 · 1 comment

Comments

@erikbosch
Copy link
Collaborator

erikbosch commented Feb 9, 2023

Today you can use overlays to both add new signals as well refactor existing signals. This gives a potential problem, if you do a spelling error or if a signal has been renamed or removed in standard VSS catalog your overlay may not do what you expect.

I am thinking if vss-tools possibly should support an attribute overlay: ['add'|'modify'] ( or similar like new: True|False) that could be used in overlays to describe if the overlay intend to add a new signal or change an existing signal. Then tooling could give a warning if the directive does not match reality.

Vehicle.Boddy.RefuelPosition:
  datatype: string
  type: attribute
  allowed: ['ALT1','ALT2']
  overlay: ['add'|'modify']
  description: Location of the fuel cap or charge port.
@SebastianSchildt
Copy link
Collaborator

SebastianSchildt commented Mar 1, 2023

maybe rather create or modify. (so that "add" can not be misunderstood as "adding" entries the allowed or instances (which is not the intention I guess)

And it should have a default, when not given. Not sure which is better, that depends how you use overlays :D

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants