Back to all reviewers

Logical content organization

astral-sh/ruff
Based on 2 comments
Markdown

Organize code and documentation logically based on functionality and dependencies. Place files in directories that reflect their purpose rather than superficial characteristics. Structure documentation so prerequisite concepts appear before concepts that depend on them.

Code Style Markdown

Reviewer Prompt

Organize code and documentation logically based on functionality and dependencies. Place files in directories that reflect their purpose rather than superficial characteristics. Structure documentation so prerequisite concepts appear before concepts that depend on them.

For example:

  • Test files should be placed in directories matching their core functionality (e.g., tests for special-cased functions should go in the appropriate special-case directory, not in unrelated directories)
  • Documentation sections should be ordered so that foundational concepts are introduced first, especially when other sections build upon them (e.g., putting the “Callable” section before “Tuple” when callable arguments are used to demonstrate contravariant contexts)

This organizational approach improves readability, makes the codebase more intuitive to navigate, and helps developers understand relationships between different components.

2
Comments Analyzed
Markdown
Primary Language
Code Style
Category

Source Discussions