Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

die_if_no_git not listed under west API #706

Open
Nick-Munnich opened this issue Mar 28, 2024 · 2 comments
Open

die_if_no_git not listed under west API #706

Nick-Munnich opened this issue Mar 28, 2024 · 2 comments
Assignees

Comments

@Nick-Munnich
Copy link

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
Copy link
Collaborator

marc-hb commented Mar 29, 2024

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
Copy link
Author

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.

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

No branches or pull requests

3 participants