Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions docs/quick_start/2.-cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,20 @@ Finally, isort can just as easily be ran against individual source files. Simply

<script id="asciicast-346602" src="https://asciinema.org/a/346602.js" async></script>

## Temporary Files

By default, when isort processes a source file, it writes the result to a
sibling temporary file by appending `.isorted` to the source filename. If the
content changes, this temporary file replaces the original. isort removes the
temporary file when processing finishes and also attempts cleanup if sorting
raises an exception.

If the process terminates before cleanup runs, the temporary file may remain.
It can be removed after isort has stopped. Projects where abrupt termination is
possible can ignore `*.isorted` files, or use the
[`--overwrite-in-place`](../configuration/options.md#overwrite-in-place)
option to avoid creating them, with a performance and memory usage penalty.

## Multiple Projects

Running a single isort command across multiple projects, or source files spanning multiple projects, is highly discouraged. Instead it is recommended that an isort process (or command) is ran for each project independently. This is because isort creates an immutable config for each CLI instance.
Expand Down
Loading