6FPS/tidal-dl
3
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

chore: 🔧 Update docstring guidelines in coding standards

Browse Source 
* 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.
This commit is contained in:
Robert Honz
2025-07-01 10:34:20 +02:00
parent 6395a00ed6
commit ca927984d3
1 changed files with 5 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files
.github/copilot-instructions.md
+5 -5
View File
@@ -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.