Skip to content

Documentation of some top-level messages is missing #836

Closed
@TimmRuppert

Description

@TimmRuppert

Describe the bug

According to this page TrafficCommandUpdate and HostVehicleData
are top-level messages but they are missing a sub chapter in "2.2.2 Top-level interfaces"

Describe how to reproduce the bug

Steps to reproduce the behavior:

  1. Go to https://opensimulationinterface.github.io/osi-antora-generator/asamosi/V3.7.0/interface/architecture/architecture_overview.html
  2. Compare the first paragraph with the chapters under 2.2.2

Describe the expected behavior

A "Top-level interfaces" chapters should include all top-level messages.

Show some screenshots

image

Additional context

When adding those chapters it would also recommend doing the following:

  • Simplify the sentence about the history of when which message/interface came with which version.
  • Precise usage of interface and message or just use one of them. E.g. the chapter is named "2.2.2 Top-level interfaces" but the subtext for such an interface starts with "GroundTruth messages describes..." or "SensorData messages imitate.."
    • Imho I would replace most occurrences of the word "interface" with "message" (some might argue they are two different things but I don't think this is more important than understanding the documentation a bit better)

I have never used TrafficCommandUpdate and thus might not be the expert to provide a quick chapter about it. In case there is nobody suitable available to fix this issue I could provide a PR where I simply copy the text of the class description

Metadata

Metadata

Labels

DocumentationEverything which impacts the quality of the documentation and guidelines.ReadyForCCBReviewIndicates that this MR is ready for a final review and merge by the CCB.

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions