Skip to content

docs: explain comment handling during sorting - #2621

Open
Himanshuagrawal4 wants to merge 1 commit into
PyCQA:mainfrom
Himanshuagrawal4:PRO/isort-comment-sorting-docs-20260808
Open

docs: explain comment handling during sorting#2621
Himanshuagrawal4 wants to merge 1 commit into
PyCQA:mainfrom
Himanshuagrawal4:PRO/isort-comment-sorting-docs-20260808

Conversation

@Himanshuagrawal4

Copy link
Copy Markdown

Summary

  • document how leading, same-module, multiline, and inline import comments are rendered
  • link to action comments and the configuration options that affect comment handling
  • add the new page to the documentation index

Closes #1843

Validation

  • compared all four documented transformations with the current isort.code output
  • built the complete Sphinx documentation environment with warnings treated as errors using the network-independent dummy builder

@Himanshuagrawal4
Himanshuagrawal4 marked this pull request as ready for review August 8, 2026 19:19
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.

Add some documentation about how isort moves comments.

1 participant