Skip to content

Commit 0e00971

Browse files
author
Nader Thomas
committed
Fullfilled a rebase with sign off.
Signed-off-by: Nader Thomas <a442105@europe.bmw.corp>
1 parent af2dd44 commit 0e00971

File tree

2 files changed

+0
-151
lines changed

2 files changed

+0
-151
lines changed

doc/interfaceconventions.rst

Lines changed: 0 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -37,11 +37,7 @@ All messages that are intended to be exchanged as a stand-alone message, i.e. no
3737
3838
Field Message Naming
3939
---------------------
40-
<<<<<<< HEAD
41-
After defining a message fields can be added to it in snake case format. This means every letter is lower case and the words are connected through an underline character. See example below:
42-
=======
4340
After defining a message fields can be added to it in snake_case format. This means every letter is lower case and the words are connected through an underline character. See example below:
44-
>>>>>>> master
4541

4642
.. code-block:: protobuf
4743
@@ -59,11 +55,7 @@ All field numbers of 10000 and above are reserved for user-defined extensions an
5955

6056
Enum Naming
6157
------------
62-
<<<<<<< HEAD
63-
The naming of an enum should be camel case. See example below:
64-
=======
6558
The naming of an enum should be PascalCase. See example below:
66-
>>>>>>> master
6759

6860
.. code-block:: protobuf
6961
@@ -78,11 +70,7 @@ The naming of an enum should be PascalCase. See example below:
7870
7971
Enum Field Naming
8072
------------
81-
<<<<<<< HEAD
82-
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:
83-
=======
8473
The naming of an enum field should be all in upper case. The start should be converted from the enum name PascalCase 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:
85-
>>>>>>> master
8674

8775
.. code-block:: protobuf
8876
@@ -104,22 +92,12 @@ Summary
10492
--------
10593
Here a small summary for the naming conventions:
10694

107-
<<<<<<< HEAD
108-
Messages: camel case
109-
110-
Message Fields: snake case
111-
112-
Enum: camel case
113-
114-
Enum Fields: upper case, name of enum converted in upper case snake case and then following the specified name
115-
=======
11695
Messages: PascalCase
11796

11897
Message Fields: snake_case
11998

12099
Enum: PascalCase
121100

122101
Enum Fields: Name of enum converted in UPPER_CASE_SNAKE_CASE and then following the specified name
123-
>>>>>>> master
124102

125103
After defining the messages do not forget to comment them. See also the `section for commenting <https://opensimulationinterface.github.io/osi-documentation/open-simulation-interface/doc/commenting.html>`_ of fields and messages.

doc/interfaceconventions.rst.orig

Lines changed: 0 additions & 129 deletions
This file was deleted.

0 commit comments

Comments
 (0)