Skip to content

Fix two typos in proto documentation comments - #917

Open
Jah-yee wants to merge 1 commit into
OpenSimulationInterface:masterfrom
Jah-yee:master
Open

Jah-yee wants to merge 1 commit into
OpenSimulationInterface:masterfrom
Jah-yee:master

Conversation

@Jah-yee

@Jah-yee Jah-yee commented Oct 18, 2026

Copy link
Copy Markdown

Description

Fix two typos in proto documentation comments, addressing issue #915.

Changes

  • osi_hostvehicledata.proto:136: sate -> state in the OPERATING_STATE_STANDBY comment
  • osi_trafficsign.proto:5649: contraints -> constraints in TYPE supplementary signs comment

Testing

No functional changes - documentation only.

Closes #915

- osi_hostvehicledata.proto: 'sate' -> 'state' in OPERATING_STATE_STANDBY comment
- osi_trafficsign.proto: 'contraints' -> 'constraints' in TYPE supplementary signs comment

Closes OpenSimulationInterface#915

Signed-off-by: Jah-yee <166608075+Jah-yee@users.noreply.github.com>
@Jah-yee

Jah-yee commented Nov 1, 2026

Copy link
Copy Markdown
Author

Hi @OpenSimulationInterface, checking in on this documentation-only typo fix that closes issue #915.

The change touches exactly two comment lines and no protobuf definitions or field numbers:

  • osi_hostvehicledata.proto:136 — sate -> state in the OPERATING_STATE_STANDBY comment ("not in their minimum electrical sate").
  • osi_trafficsign.proto:5649 — contraints -> constraints in the TYPE supplementary signs comment ("If supplementary signs combine contraints, restrictions, or plain text...").

Both are inside // comments in the .proto sources, so the compiled descriptor and wire format are byte-for-byte identical — no API or behaviour change. The PR is a single commit with a 2-line diff and the branch is mergeable against master.

If there is a preferred location for such fixes on this repo (for example a separate docs label or a different branch naming), or if you would rather collect them into one larger typo PR, just say the word and I will adapt. Otherwise happy for you to merge it as-is. Thanks for reviewing!

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Minor documentation typos in .proto files

1 participant