chore: 🔧 Update docstring guidelines for typing usage

- Added clarification to the docstring guidelines to include the use of `typing` in docstrings.
This commit is contained in:
Robert Honz
2025-07-01 11:04:58 +02:00
parent de47935f04
commit 1f7d8a15e2
+1 -1
View File
@@ -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.