Renaming "allowed" literals according to guidelines #404
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
SebastianSchildt
approved these changes
Jan 28, 2022
gunnarx
previously requested changes
Feb 1, 2022
21b0051 to
72e3db6
Compare
|
@gunnarx - now PR is updated |
|
Maybe we shall wait a little with merging this one. I noticed that our tooling do some unexpected conversion of string literals not quoted, well at least unexpected for me. |
|
Meeting notes:
|
72e3db6 to
888bb3a
Compare
Also changing guidelines to recommend quotation marks. Background: Otherwise literals like ON, OFF, FALSE might be transformed by tooling. Notes: Private-branch (CARFIT) not updated - private branch so not covered by recommendations Signed-off-by: Erik Jaegervall <erik.jaegervall@se.bosch.com>
888bb3a to
015a23d
Compare
|
meeting approved 15/02/22 |
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 is an attempt to harmonize the use of literals for "allowed" values in the VSS standard, so that they as default use only uppercase, number and underscore. That has in this PR been consistently changed, but there might be some cases where it can be discussed if the recommendation shall be followed or not.
In most cases the change is straight forward, but for some a bit more advanced "translation" has been proposed, e.g. replacing
kWh/100miwithKILOWATT_HOURS_PER_100_MILES.This PR has not analyzed if the values/signals actually make sense, i.e. no values have been added/removed, the semantic meaning of each is supposed to be the same after the rename. Also
UNKNOWNis kept as is, it need to be discussed on signal by signal basis whether it makes sense to keep it or not.Notes:
Private-branch (CARFIT) not updated - private branch so not covered by recommendations. Branches reflecting other standards/solutions might also be a typical case where it might be a reason not to follow the recommendation. If e.g. CARFIT use
abc, then it might be less useful to require that it shall beABCin VSS.