Welcome to pylint-sort-functions’s documentation!

A pylint plugin that enforces alphabetical sorting of functions and methods within Python modules and classes.

Getting Started:

• Introduction
  • Features
  • Installation
  • Quick Start
  • Message Codes
• User Guide
  • Installation
  • Quick Start
  • Configuration
  • Message Types
  • Sorting Rules
  • Disabling Messages
  • Command Line Options
  • Integration with IDEs
  • Best Practices
  • Troubleshooting
  • Output Format
  • Summary
• Known Issues & Workarounds
  • Framework Decorator Issues
  • Test Method Ordering
  • Magic Methods (__init__, __str__, etc.)
  • Bulk Violations
  • Getting Better Error Messages
  • Project-Wide Configuration
  • Selective Enforcement Strategy
  • Configuration Templates
  • Getting Help

Reference:

• API Reference
  • Checker Module
  • Messages Module
  • Utilities Module
  • Plugin Registration
• Developer Guide
  • Overview
  • PyLint Plugin Architecture
  • Core Components
  • AST and PyLint Integration Details
  • Sorting Logic
  • Advanced Features
  • Extending the Plugin
  • Development Workflow
  • Debugging Tips
  • Performance Considerations
  • Conclusion
• Development Roadmap
  • Version 0.2.0 - Framework Awareness & Configuration
  • Version 0.2.1 - Auto-fix Improvements
  • Version 0.3.0 - Advanced Features
  • Version 0.4.0 - Polish & Stability
  • Implementation Strategy
  • Success Metrics
  • Contributing
  • Getting Involved

Quick Links

• Having issues? Check Known Issues & Workarounds for immediate solutions

• Want new features? See our Development Roadmap for planned improvements

• Found a bug? Report it on GitHub Issues

Indices and tables

• Index

• Module Index

• Search Page