6FPS/tidal-dl

Files

T

Robert Honz 4dde8c819a 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.

2025-07-01 11:33:04 +02:00

786 B

Raw Blame History

applyTo

applyTo
*/.py

Project general coding standards

Naming Conventions

Use snake_case for variable and function names.
Use CamelCase for class names.
Follow PEP 8 style guidelines.
Prefix private class members with underscore (_).
Use ALL_CAPS for constants.

Error Handling

Use try/except blocks for async operations.
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.