diff options
| author | Robert Honz <exislow+github@gmail.com> | 2025-07-02 09:56:57 +0200 |
|---|---|---|
| committer | Robert Honz <exislow+github@gmail.com> | 2025-07-02 09:56:57 +0200 |
| commit | 6d7f4f1625cb57f3d8c58f9b2e07dd759834cc23 (patch) | |
| tree | 9c578443e2672a0e9e530054d5102c32435b68e1 /.github | |
| parent | 35d4ff92298415b927f2d41c20b19e9efec64198 (diff) | |
| download | tidal-dl-ng-6d7f4f1625cb57f3d8c58f9b2e07dd759834cc23.tar.gz | |
refactor(guidelines): ✨ Improve clarity in coding standards
* Enhanced wording for better understanding of blank line usage.
* Clarified instructions on updating docstrings during refactoring.
* Specified the use of line comments for complex logic explanations.
Diffstat (limited to '.github')
| -rw-r--r-- | .github/copilot-instructions.md | 6 |
1 files changed, 4 insertions, 2 deletions
diff --git a/.github/copilot-instructions.md b/.github/copilot-instructions.md index bc8e87e..f62d2fa 100644 --- a/.github/copilot-instructions.md +++ b/.github/copilot-instructions.md @@ -22,7 +22,7 @@ applyTo: "**/*.py" - 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. +- Use more blank lines to achieve better code organization and readability. - Follow PEP 492 – Coroutines with async and await syntax - Follow PEP 498 – Literal String Interpolation - Follow PEP 572 – Assignment Expressions @@ -31,4 +31,6 @@ applyTo: "**/*.py" - 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. +- Use line comments to explain complex logic. +- If refactoring code, ensure to update or add doc strings accordingly. +- If refactoring code to not remove existing line comments, but to update them to reflect the new code logic. |