Skip to content

Update comment to specify minivan TYPE_CAR categorization#910

Open
johschmitz wants to merge 1 commit into
OpenSimulationInterface:masterfrom
johschmitz:patch-1
Open

Update comment to specify minivan TYPE_CAR categorization#910
johschmitz wants to merge 1 commit into
OpenSimulationInterface:masterfrom
johschmitz:patch-1

Conversation

@johschmitz

Copy link
Copy Markdown

Reference to a related issue in the repository

#909

Add a description

Make description unambiguous.

Some questions to ask:
What is this change?
What does it fix?
Is this a bug fix or a feature? Does it break any existing functionality or force me to update to a new version?
How has it been tested?

Take this checklist as orientation for yourself, if this PR is ready for the Change Control Board:

If you can’t check all of them, please explain why.
If all boxes are checked or commented and you have achieved at least one positive review, you can assign the label ReadyForCCBReview!

Signed-off-by: Johannes Schmitz <johannes.schmitz1@gmail.com>
@thomassedlmayer

Copy link
Copy Markdown
Contributor

Shouldn't it be clear already which category to use because the other car classifications are deprecated and are not recommended to be used?

@johschmitz

Copy link
Copy Markdown
Author

@thomassedlmayer maybe for someone deep in the trenches of OSI this is clear. For someone like me who just has very occasional contact it is not clear. My expectation as a software engineer though would be that it is written as clear as possible for a broad audience. Also my expectation nowadays as an LLM user would be to make APIs and their documentations simple and explicit. It would take an LLM agent significantly more tokens to find out this whole depreciation based constraints and implement it right compared to just writing this explicitly like I am proposing.
In the end it is up to the maintainers to decide whether to merge this or not. It is just a single line and a single click to merge, I don't think it is worth a lot of additional discussions.

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.

2 participants