diff options
| author | Robert Honz <exislow+github@gmail.com> | 2025-07-01 11:04:58 +0200 |
|---|---|---|
| committer | Robert Honz <exislow+github@gmail.com> | 2025-07-01 11:04:58 +0200 |
| commit | 1f7d8a15e2a9480976b3a1bc2af84aa939bd2c27 (patch) | |
| tree | b9837143c4cccc3ff521c4149dadadbbb60317a6 | |
| parent | de47935f049cdab38cbe5ccd665176761ec2c632 (diff) | |
| download | tidal-dl-ng-1f7d8a15e2a9480976b3a1bc2af84aa939bd2c27.tar.gz | |
chore: 🔧 Update docstring guidelines for typing usage
- Added clarification to the docstring guidelines to include the use of `typing` in docstrings.
| -rw-r--r-- | .github/copilot-instructions.md | 2 |
1 files changed, 1 insertions, 1 deletions
diff --git a/.github/copilot-instructions.md b/.github/copilot-instructions.md index 0604a99..f10cd46 100644 --- a/.github/copilot-instructions.md +++ b/.github/copilot-instructions.md @@ -10,7 +10,7 @@ applyTo: "**/*.py" - 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. +- 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. |