summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorRobert Honz <exislow+github@gmail.com>2025-07-02 08:49:32 +0200
committerRobert Honz <exislow+github@gmail.com>2025-07-02 08:49:32 +0200
commit6d62a3b5c040abd9a0a666c5a930fcd5378101f3 (patch)
treeae506a160fe454d38ec02d73968bf81d7668f2e7
parentfd16a620f2853b2bbb5e943c4ebd356945d352b9 (diff)
downloadtidal-dl-ng-6d62a3b5c040abd9a0a666c5a930fcd5378101f3.tar.gz
refactor(guidelines): ✨ Update coding standards for type annotations
* Added a guideline to use modern built-in generics from the `typing` module. * This change aligns with PEP 484 and promotes better coding practices.
-rw-r--r--.github/copilot-instructions.md1
1 files changed, 1 insertions, 0 deletions
diff --git a/.github/copilot-instructions.md b/.github/copilot-instructions.md
index c890c0c..bc8e87e 100644
--- a/.github/copilot-instructions.md
+++ b/.github/copilot-instructions.md
@@ -20,6 +20,7 @@ applyTo: "**/*.py"
## Coding Guidelines
- Use type annotations / hints for function and method parameters, return types and variables. Follow PEP 484.
+- Use the modern built-in generics from the `typing` module, such as `list`, `dict`, and `set`, instead of the older `List`, `Dict`, and `Set` from `typing`.
- 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