From ca927984d350328323b7d907067119cc2f19baf6 Mon Sep 17 00:00:00 2001 From: Robert Honz Date: Tue, 1 Jul 2025 10:34:20 +0200 Subject: [PATCH] =?UTF-8?q?chore:=20=F0=9F=94=A7=20Update=20docstring=20gu?= =?UTF-8?q?idelines=20in=20coding=20standards?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * 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. --- .github/copilot-instructions.md | 10 +++++----- 1 file 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.