-
Notifications
You must be signed in to change notification settings - Fork 131
Documentation/interface convention #380
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
Merged
Merged
Conversation
This file contains hidden or 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
pmai
approved these changes
Feb 19, 2020
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
With the additions looking good.
goretkin
reviewed
Feb 19, 2020
|
||
Enum Field Naming | ||
------------ | ||
The naming of an enum field should be all in upper case. The start should be converted from the enum name camel case to upper case snake case. It is mandatory to add to the first enum field name the postfix ``_UNKNOWN`` and to the second the postfix ``_OTHER``. After that the naming can be decided by the user. It is often mentioned that the value ``_UNKNOWN`` should not be used in a ``GroundTruth`` message as there are now uncertanties by definition in ``the truth``. These values are mostly used in messages like ``SensorData`` where the content is subject to interpretation. See example below: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
now uncertanties
-> no uncertainties
ThomasNaderBMW
pushed a commit
that referenced
this pull request
Jan 26, 2021
* Changed numeric list for citation * Adding interface naming convention * Added section about the use of UNKNOWN in GT Signed-off-by: Nader Thomas <a442105@europe.bmw.corp>
ThomasNaderBMW
pushed a commit
that referenced
this pull request
Jun 30, 2021
* Changed numeric list for citation * Adding interface naming convention * Added section about the use of UNKNOWN in GT Signed-off-by: Nader Thomas <a442105@europe.bmw.corp>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Labels
Documentation
Everything which impacts the quality of the documentation and guidelines.
Quality
Quality improvements.
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.
Reference to a related issue in the repository
resolves #337
Add a description
Adding documentation to message, message fields, enum and enum fields.
Mention a member
@jdsika pls review:)
Check the checklist