Skip to content

Commit e83daf5

Browse files
authored
Merge pull request #19 from OpenSimulationInterface/bug/readme-update
fix typos and style in Readme.md
2 parents 11327b5 + ad2e702 commit e83daf5

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -21,13 +21,13 @@ Compatibility
2121
Defintion: FAITHFULLY "All recorded data is correctly interpreted by the interface"
2222

2323
Forward compatibility:
24-
Definition: "An older verison of code can be used to read new files"
25-
Data recorded with a higher minor or patch version of a major version can be read with code using the same major version but lower minor and patch version.
26-
Newly added fields are ignored. All patch versions of the same major and minor version is FAITHFULLY forward compatible.
24+
Definition: "An older version of the code can be used to read new files"
25+
Data recorded with a higher minor or patch version can be interpreted by code built using the same major version of the interface but lower minor and/or patch version.
26+
In this case, additional fields of a newer minor version are silently ignored. All patch versions of the same major and minor version are FAITHFULLY forward compatible.
2727

2828
Backward compatibility:
2929
Definition: "A newer version of code can be used to read old files"
30-
All files which have been recorded in the past with a specicific major version are FAITHFULLY valid with all combinations of
30+
All files that have been recorded in the past with a specific major version are FAITHFULLY valid with all combinations of
3131
higher minor and patch versions of the same major version.
3232

3333

@@ -36,9 +36,9 @@ Fault injection: how-to
3636
Injection of pre-defined sensor errors should be handled by a specialized "fault injector" component that acts like a
3737
sensor model component, i.e. it takes a SensorData message as input and returns a modified SensorData message as output.
3838
Specific errors should be handled as follows:
39-
-- Ghost objects / false positive: An additional SensorDataObject is added to the list of objects in SensorData.object
39+
- Ghost objects / false positive: An additional SensorDataObject is added to the list of objects in SensorData.object
4040
with SensorDataObject.model_internal_object.ground_truth_type set to kTypeGhost.
41-
-- False negative: The object is marked as not seen by the sensor by setting the property
41+
- False negative: The object is marked as not seen by the sensor by setting the property
4242
SensorDataObject.model_internal_object.is_seen to false. The implementation of field-of-view calculation modules
4343
should respect this flag and never reset an object marked as not-seen to seen.
4444

@@ -66,4 +66,4 @@ Patch:
6666
The compatibility of both recorded files and code remains.
6767
- File or folder structure which does not affect including the code in other projects
6868
- Changing or adding comments
69-
- Clarification of text passages explaining the message content
69+
- Clarification of text passages explaining the message content

0 commit comments

Comments
 (0)