Files
tidal-dl/.github/copilot-instructions.md
T
Robert Honz 1f7d8a15e2 chore: 🔧 Update docstring guidelines for typing usage
- Added clarification to the docstring guidelines to include the use of `typing` in docstrings.
2025-07-01 11:04:58 +02:00

670 B

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.
  • 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 (_).
  • Use ALL_CAPS for constants.
  • Use newest coding style which is supported by the used Python version.

Error Handling

  • Use try/except blocks for async operations.
  • Always log errors with contextual information.