Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit 6000d37

Browse files
authored
Add Clarification to Config File Location/Name (psf#4533)
1 parent 30759ca commit 6000d37

1 file changed

Lines changed: 4 additions & 3 deletions

File tree

docs/usage_and_configuration/the_basics.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -478,9 +478,10 @@ operating system, this configuration file should be stored as:
478478
`XDG_CONFIG_HOME` environment variable is not set)
479479

480480
Note that these are paths to the TOML file itself (meaning that they shouldn't be named
481-
as `pyproject.toml`), not directories where you store the configuration. Here, `~`
482-
refers to the path to your home directory. On Windows, this will be something like
483-
`C:\\Users\UserName`.
481+
as `pyproject.toml`), not directories where you store the configuration (i.e.,
482+
`black`/`.black` is the file to create and add your configuration options to, in the
483+
`~/.config/` directory). Here, `~` refers to the path to your home directory. On
484+
Windows, this will be something like `C:\\Users\UserName`.
484485

485486
You can also explicitly specify the path to a particular file that you want with
486487
`--config`. In this situation _Black_ will not look for any other file.

0 commit comments

Comments
 (0)