Skip to content

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 9 commits into from
Feb 19, 2020
Merged

Conversation

vkresch
Copy link
Contributor

@vkresch vkresch commented Feb 19, 2020

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

  • My code and comments follow the style guidelines and contributors guidelines of this project.
  • I have performed a self-review of my own code.
  • I have made corresponding changes to the documentation.
  • My changes generate no new warnings.
  • I have added tests that prove my fix is effective or that my feature works.
  • New and existing unit tests / travis ci pass locally with my changes.

@vkresch vkresch added Documentation Everything which impacts the quality of the documentation and guidelines. Quality Quality improvements. labels Feb 19, 2020
@vkresch vkresch requested a review from jdsika February 19, 2020 11:55
@vkresch vkresch self-assigned this Feb 19, 2020
Copy link
Contributor

@pmai pmai left a 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.

@pmai pmai added this to the v3.2.0 milestone Feb 19, 2020
@jdsika jdsika removed their request for review February 19, 2020 13:00
@jdsika jdsika merged commit 68b1ac9 into master 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:

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

now uncertanties -> no uncertainties

@pmai pmai deleted the documentation/interface-convention branch April 27, 2020 11:39
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.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Clarification of other places for EnvironmentalConditions
4 participants