summaryrefslogtreecommitdiff
path: root/docs/upgrade_guides/5.0.0.md
diff options
context:
space:
mode:
authorTimothy Crosley <timothy.crosley@gmail.com>2020-10-01 23:25:51 -0700
committerTimothy Crosley <timothy.crosley@gmail.com>2020-10-01 23:25:51 -0700
commita00ac1c8825c901b4692ea03f4786ac4f20a0947 (patch)
tree2c2a7665241794487209adbc7f302b171f233d35 /docs/upgrade_guides/5.0.0.md
parentb583c12d8218bf499b5063b2a3fe657a6b2b2a3b (diff)
downloadisort-a00ac1c8825c901b4692ea03f4786ac4f20a0947.tar.gz
Fix #1481: more prominent callout for how config files are loaded
Diffstat (limited to 'docs/upgrade_guides/5.0.0.md')
-rw-r--r--docs/upgrade_guides/5.0.0.md4
1 files changed, 4 insertions, 0 deletions
diff --git a/docs/upgrade_guides/5.0.0.md b/docs/upgrade_guides/5.0.0.md
index d31fb9dc..fb767c2c 100644
--- a/docs/upgrade_guides/5.0.0.md
+++ b/docs/upgrade_guides/5.0.0.md
@@ -48,6 +48,10 @@ The first thing to keep in mind is how isort loads config options has changed in
If you have multiple configs, they will need to be merged into 1 single one. You can see the priority order of configuration files and the manner in which they are loaded on the
[config files documentation page](https://pycqa.github.io/isort/docs/configuration/config_files/).
+!!! tip - "Config options are loaded relative to the file, not the isort instance."
+ isort looks for a config file based on the path of the file you request to sort. If you have your config placed outside of the project, you can use `--settings-path` to manually specify the config location instead. Full information about how config files are loaded is in the linked config files documentation page.
+
+
### `not_skip`
This is the same as the `--dont-skip` CLI option above. In an earlier version isort had a default skip of `__init__.py`. To get around that many projects wanted a way to not skip `__init__.py` or any other files that were automatically skipped in the future by isort. isort no longer has any default skips, so if the value here is `__init__.py` you can simply remove the setting. If it is something else, just make sure you aren't specifying to skip that file somewhere else in your config.