actions/black
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Add Clarification to Config File Location/Name (#4533)

Browse Source
This commit is contained in:
Ac5000 2024-12-19 19:07:27 -05:00 committed by GitHub
parent 30759ca782
commit 6000d37f09
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 4 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
docs/usage_and_configuration/the_basics.md
View File

@ -478,9 +478,10 @@ operating system, this configuration file should be stored as:
`XDG_CONFIG_HOME` environment variable is not set) `XDG_CONFIG_HOME` environment variable is not set)
Note that these are paths to the TOML file itself (meaning that they shouldn't be named Note that these are paths to the TOML file itself (meaning that they shouldn't be named
as `pyproject.toml`), not directories where you store the configuration. Here, `~` as `pyproject.toml`), not directories where you store the configuration (i.e.,
refers to the path to your home directory. On Windows, this will be something like `black`/`.black` is the file to create and add your configuration options to, in the
`C:\\Users\UserName`. `~/.config/` directory). Here, `~` refers to the path to your home directory. On
Windows, this will be something like `C:\\Users\UserName`.
You can also explicitly specify the path to a particular file that you want with You can also explicitly specify the path to a particular file that you want with
`--config`. In this situation _Black_ will not look for any other file. `--config`. In this situation _Black_ will not look for any other file.