refactor(guidelines): ✨ Update coding standards for type annotations and add PEP references
* Clarified type annotations usage for function parameters, return types, and variables. * Added guidelines for using blank lines, coroutines, and string interpolation as per PEP standards.
This commit is contained in:
@@ -19,8 +19,12 @@ applyTo: "**/*.py"
|
|||||||
|
|
||||||
## Coding Guidelines
|
## Coding Guidelines
|
||||||
|
|
||||||
- Use type annotations for function parameters, return types and variables.
|
- Use type annotations / hints for function and method parameters, return types and variables. Follow PEP 484.
|
||||||
- Use newest coding style which is supported by the used Python version.
|
- Use newest coding style which is supported by the used Python version.
|
||||||
|
- Use blank lines to keep code organized and readable.
|
||||||
|
- Follow PEP 492 – Coroutines with async and await syntax
|
||||||
|
- Follow PEP 498 – Literal String Interpolation
|
||||||
|
- Follow PEP 572 – Assignment Expressions
|
||||||
|
|
||||||
## Code Documentation
|
## Code Documentation
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user