Review: Onebitme patch 1 (#412)

* Changed all remainings of camel case
Signed-off-by: Carlo van Driesten <[email protected]>
Co-authored-by: Ersun Sözen <[email protected]>

Author: jdsika

doc/interfaceconventions.rst

@@ -7,7 +7,7 @@ When adding new messages, enums, field messages and field enums to OSI we enforc
 
 Message Naming
 ---------------
-A message definition should always be in camel case. This means that the first letter of each word in a message should be upper case without any spaces. See example below:
+A message definition should always be in PascalCase. This means that the first letter of each word in a message should be upper case without any spaces. See example below:
 
 .. code-block:: protobuf
 
@@ -37,7 +37,7 @@ All messages that are intended to be exchanged as a stand-alone message, i.e. no
 
 Field Message Naming
 ---------------------
-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:
+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:
 
 .. code-block:: protobuf
 
@@ -55,7 +55,7 @@ All field numbers of 10000 and above are reserved for user-defined extensions an
 
 Enum Naming
 ------------
-The naming of an enum should be camel case. See example below:
+The naming of an enum should be PascalCase. See example below:
 
 .. code-block:: protobuf
 
@@ -70,7 +70,7 @@ The naming of an enum should be camel case. See example below:
 
 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:
+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:
 
 .. code-block:: protobuf
 
@@ -92,12 +92,12 @@ Summary
 --------
 Here a small summary for the naming conventions:
 
-Messages: camel case
+Messages: PascalCase
 
-Message Fields: snake case
+Message Fields: snake_case
 
-Enum: camel case
+Enum: PascalCase
 
-Enum Fields: upper case, name of enum converted in upper case snake case and then following the specified name
+Enum Fields: Name of enum converted in UPPER_CASE_SNAKE_CASE and then following the specified name
 
 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.

tests/test_invalid_enum.py

@@ -45,7 +45,7 @@ def test_correct_enum_name(self):
                         saveStatement = statement[matchSep.end():]
                         statement = statement[:matchSep.end()]
 
-                    # This section will check camelcase for enums and check enum name?
+                    # This section will check PascalCase for enums and check enum name?
 
                     if isEnum is True:
                         matchName = re.search(r"\b\w[\S:]+\b", statement)
@@ -117,7 +117,7 @@ def test_invalid_enum(self):
                         saveStatement = statement[matchSep.end():]
                         statement = statement[:matchSep.end()]
 
-                    # This section will check camelcase for enums and check enum name?
+                    # This section will check PascalCase for enums and check enum name?
 
                     if isEnum is True:
                         matchName = re.search(r"\b\w[\S:]+\b", statement)