From 4dde8c819a82a763e8b5df8a843559a2aafd3e4b Mon Sep 17 00:00:00 2001 From: Robert Honz Date: Tue, 1 Jul 2025 11:33:04 +0200 Subject: [PATCH] =?UTF-8?q?chore:=20=F0=9F=94=A7=20Update=20coding=20stand?= =?UTF-8?q?ards=20and=20documentation=20guidelines?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * Refined coding guidelines for clarity and structure. * Added sections for type annotations and docstring requirements. * Ensured consistency in documentation practices across the project. --- .github/copilot-instructions.md | 14 +++++++++++--- 1 file changed, 11 insertions(+), 3 deletions(-) diff --git a/.github/copilot-instructions.md b/.github/copilot-instructions.md index f10cd46..472850f 100644 --- a/.github/copilot-instructions.md +++ b/.github/copilot-instructions.md @@ -9,13 +9,21 @@ applyTo: "**/*.py" - Use snake_case for variable and function names. - 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. 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. ## Error Handling - Use try/except blocks for async operations. - Always log errors with contextual information. + +## Coding Guidelines + +- Use type annotations for function parameters, return types and variables. +- Use newest coding style which is supported by the used Python version. + +## Code Documentation + +- 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.