chore: 🔧 Update coding standards and documentation guidelines
* Refined coding guidelines for clarity and structure. * Added sections for type annotations and docstring requirements. * Ensured consistency in documentation practices across the project.
This commit is contained in:
@@ -9,13 +9,21 @@ applyTo: "**/*.py"
|
|||||||
- Use snake_case for variable and function names.
|
- Use snake_case for variable and function names.
|
||||||
- Use CamelCase for class names.
|
- Use CamelCase for class names.
|
||||||
- Follow PEP 8 style guidelines.
|
- Follow PEP 8 style guidelines.
|
||||||
- Include type hints for function parameters and return types.
|
|
||||||
- Always write doc strings for all modules, classes, functions, and methods using google docstring style. Use typing in doc strings.
|
|
||||||
- Prefix private class members with underscore (\_).
|
- Prefix private class members with underscore (\_).
|
||||||
- Use ALL_CAPS for constants.
|
- Use ALL_CAPS for constants.
|
||||||
- Use newest coding style which is supported by the used Python version.
|
|
||||||
|
|
||||||
## Error Handling
|
## Error Handling
|
||||||
|
|
||||||
- Use try/except blocks for async operations.
|
- Use try/except blocks for async operations.
|
||||||
- Always log errors with contextual information.
|
- Always log errors with contextual information.
|
||||||
|
|
||||||
|
## Coding Guidelines
|
||||||
|
|
||||||
|
- Use type annotations for function parameters, return types and variables.
|
||||||
|
- Use newest coding style which is supported by the used Python version.
|
||||||
|
|
||||||
|
## Code Documentation
|
||||||
|
|
||||||
|
- Always write doc strings for all modules, classes, functions, and methods using google docstring style.
|
||||||
|
- Use typing in doc strings.
|
||||||
|
- Use short inline comments to explain complex logic.
|
||||||
|
|||||||
Reference in New Issue
Block a user