Exploring Flake8’s Internals¶
While writing Flake8 3.0, the developers attempted to capture some reasoning and decision information in internal documentation meant for future developers and maintaners. Most of this information is unnecessary for users and plugin developers. Some of it, however, is linked to from the plugin development documentation.
Keep in mind that not everything will be here and you may need to help pull information out of the developers’ heads and into these documents. Please pull gently.
- Contributing to Flake8
- Writing Documentation for Flake8
- View the docs locally before submitting
- Run the docs linter tests before submitting
- Capitalize Flake8 in prose
- Use the prompt directive for command-line examples
- Wrap lines around 79 characters
- Use two new-lines before new sections
- Surround document titles with equal symbols
- Use the option template for new options
- Use anchors for easy reference linking
- Keep your audience in mind
- Writing Code for Flake8
- Releasing Flake8
- What Happens When You Run Flake8
- How Checks are Run
- Command Line Interface
- Built-in Formatters
- Option and Configuration Handling
- Plugin Handling
- Utility Functions