NeroCube / bookmark

Place some learning resources
0 stars 0 forks source link

Apply pre-commit #405

Open NeroCube opened 1 year ago

NeroCube commented 1 year ago
Package Functionality
isort Automatically sorts and organizes import statements in Python code.
black Automates the formatting of Python code to adhere to a consistent style and format.
flake8 Checks the syntax and style of Python code, providing static code analysis and error detection.
docformatter Automatically formats and standardizes Python docstrings (documentation strings).
unittest Python's standard library testing framework for writing and running unit tests.
sphinx Documentation generation tool used to create beautiful documentation and explanatory files.

These Python packages serve to enhance code quality, documentation, and unit testing. isort helps organize import statements for clearer and organized code. black provides automated code formatting for consistent style. flake8 is a static code analysis tool that checks for syntax and style issues, offering error detection and suggestions. docformatter focuses on formatting and standardizing Python docstrings to improve documentation readability. unittest is Python's standard library testing framework for writing and running unit tests. sphinx is a documentation generation tool used to create aesthetically pleasing documentation and explanatory files for developers to document and share code functionality and usage.