diff options
| author | Robert Honz <exislow+github@gmail.com> | 2025-07-01 10:34:20 +0200 |
|---|---|---|
| committer | Robert Honz <exislow+github@gmail.com> | 2025-07-01 10:34:20 +0200 |
| commit | ca927984d350328323b7d907067119cc2f19baf6 (patch) | |
| tree | fc862fa5e0cb9617e64dd3f8fdb9d9eff3886541 /.github | |
| parent | 6395a00ed611ccddf96169a5ca4e8904268e4e1b (diff) | |
| download | tidal-dl-ng-ca927984d350328323b7d907067119cc2f19baf6.tar.gz | |
chore: 🔧 Update docstring guidelines in coding standards
* Changed "Write docstrings for all public modules, classes, functions, and methods" to "Always write doc strings for all modules, classes, functions, and methods."
* Added missing punctuation for consistency in error handling guidelines.
Diffstat (limited to '.github')
| -rw-r--r-- | .github/copilot-instructions.md | 10 |
1 files changed, 5 insertions, 5 deletions
diff --git a/.github/copilot-instructions.md b/.github/copilot-instructions.md index 94aae70..0c3735c 100644 --- a/.github/copilot-instructions.md +++ b/.github/copilot-instructions.md @@ -10,11 +10,11 @@ applyTo: "**/*.py" - Use CamelCase for class names. - Follow PEP 8 style guidelines. - Include type hints for function parameters and return types. -- Write docstrings for all public modules, classes, functions, and methods using google docsrting style. -- Prefix private class members with underscore (\_) -- Use ALL_CAPS for constants +- Always write doc strings for all modules, classes, functions, and methods using google docstring style. +- 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 +- Use try/except blocks for async operations. +- Always log errors with contextual information. |