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

Clear up documentation on how the extension searches for Black #42

Closed
brettcannon opened this issue May 10, 2022 · 1 comment
Closed
Assignees
Labels
bug Issue identified by VS Code Team member as probable bug documentation Improvements or additions to documentation needs PR

Comments

@brettcannon
Copy link
Member

@brettcannon That is definitely useful for Black, though of course this issue still remains for all other linters etc.

I notice the description for black-formatter.path in your link includes as examples both an executable path and a module name, so I suppose the word path is the plan going forward to refer to either an executable or a module name in all cases, contrary to @wpyoga's suggestions in microsoft/vscode-python#4922 (comment).

In your link, what does this mean:

The bundled black is only used if there is no installed version of black found in the selected python environment.

I have not tested this. Does the extension go hunting for black in various specific locations in your environment, or does it use some PATH setting in the user's environment, or do you have to specify the black-formatter.path setting? For the first two options, can that logic be used to hunt for linters etc generally (the main point of this GitHub issue)?

Originally posted by @jeremyn in microsoft/vscode-python#4922 (comment)

@github-actions github-actions bot added the triage-needed Issue is not triaged. label May 10, 2022
@brettcannon brettcannon changed the title @brettcannon That is definitely useful for Black, though of course this issue still remains for all other linters etc. Clear up documentation on how the extension searches for Black May 10, 2022
@karthiknadig karthiknadig self-assigned this May 11, 2022
@karthiknadig karthiknadig added bug Issue identified by VS Code Team member as probable bug documentation Improvements or additions to documentation needs PR and removed triage-needed Issue is not triaged. labels May 11, 2022
@luabud
Copy link
Member

luabud commented Dec 13, 2023

We made some updates to the the README clarifying that by default we use the Black formatter shipped with the extension, and how black-formatter.path can be customized to get the one from PATH. We're happy to make more clarifying changes if needed, just let us know by creating a new issue!

@luabud luabud closed this as completed Dec 13, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Issue identified by VS Code Team member as probable bug documentation Improvements or additions to documentation needs PR
Projects
None yet
Development

No branches or pull requests

3 participants