search

zephyrproject-rtos / west

West, Zephyr's meta-tool
https://docs.zephyrproject.org/latest/guides/west/index.html
Apache License 2.0
215 stars 117 forks source link

`die_if_no_git` not listed under west API #706

Open Nick-Munnich opened 3 months ago

Nick-Munnich commented 3 months ago

die_if_no_git is a public method of WestCommand, but is not listed under https://docs.zephyrproject.org/latest/develop/west/west-apis.html#westcommand.

marc-hb commented 3 months ago

It's "public" because it's used in project.py. This does not imply it is part of the official, supported West APIs.

What is the actual problem you're experiencing?

Nick-Munnich commented 3 months ago

I wanted to use said method while writing a west extension. The positioning of the method in the source code implies (to me at least) that it was intended to be included in the API, as it is "grouped" with 3 other methods which are all part of the API under a comment reading "other public methods".

My suggestion would be to include another comment or move said method to avoid this ambiguity/source of confusion.