Skip to content

Document temporary .isorted files#2580

Merged
DanielNoord merged 1 commit into
PyCQA:mainfrom
sapunyangkut:codex/issue-1943-document-isorted-temp-files
Jul 25, 2026
Merged

Document temporary .isorted files#2580
DanielNoord merged 1 commit into
PyCQA:mainfrom
sapunyangkut:codex/issue-1943-document-isorted-temp-files

Conversation

@sapunyangkut

Copy link
Copy Markdown

Closes #1943

Summary

  • explain when isort creates a sibling .isorted temporary file
  • document normal and exception cleanup, plus possible residue after abrupt termination
  • link to --overwrite-in-place as the no-temporary-file alternative and state its documented tradeoff

Validation

  • built all documentation with the repository's strict Sphinx flags (--nitpicky --fail-on-warning --write-all --fresh-env)
  • skipped only the theme's Google Fonts download in an untracked local validation config after fonts.google.com timed out
  • verified the rendered section and internal --overwrite-in-place link
  • checked default cleanup, exception cleanup, and overwrite-in-place behavior against the current implementation
  • git diff --check

AI assistance

This documentation change was prepared with Codex assistance. I reviewed every statement against the current implementation, tightened the exception-cleanup wording after independent review, and ran the validation above.

@DanielNoord

Copy link
Copy Markdown
Member

Is this ready to be reviewed?

@sapunyangkut
sapunyangkut marked this pull request as ready for review July 18, 2026 08:44
@DanielNoord
DanielNoord enabled auto-merge July 25, 2026 13:39
@codecov

codecov Bot commented Jul 25, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 99.39%. Comparing base (a8c0004) to head (3b5ac12).
⚠️ Report is 23 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #2580   +/-   ##
=======================================
  Coverage   99.39%   99.39%           
=======================================
  Files          41       41           
  Lines        3137     3137           
  Branches      680      680           
=======================================
  Hits         3118     3118           
  Misses         11       11           
  Partials        8        8           
🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@DanielNoord
DanielNoord added this pull request to the merge queue Jul 25, 2026
Merged via the queue into PyCQA:main with commit 8dbc583 Jul 25, 2026
26 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Document .isorted temporary files?

2 participants