From 6000d37f09046cf98f37a9f5e676024d9a836ae5 Mon Sep 17 00:00:00 2001 From: Ac5000 <15003210+Ac5000@users.noreply.github.com> Date: Thu, 19 Dec 2024 19:07:27 -0500 Subject: [PATCH] Add Clarification to Config File Location/Name (#4533) --- docs/usage_and_configuration/the_basics.md | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/docs/usage_and_configuration/the_basics.md b/docs/usage_and_configuration/the_basics.md index bae72b2..6a6c939 100644 --- a/docs/usage_and_configuration/the_basics.md +++ b/docs/usage_and_configuration/the_basics.md @@ -478,9 +478,10 @@ operating system, this configuration file should be stored as: `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 -as `pyproject.toml`), not directories where you store the configuration. Here, `~` -refers to the path to your home directory. On Windows, this will be something like -`C:\\Users\UserName`. +as `pyproject.toml`), not directories where you store the configuration (i.e., +`black`/`.black` is the file to create and add your configuration options to, in the +`~/.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 `--config`. In this situation _Black_ will not look for any other file.