From 1f7d8a15e2a9480976b3a1bc2af84aa939bd2c27 Mon Sep 17 00:00:00 2001 From: Robert Honz Date: Tue, 1 Jul 2025 11:04:58 +0200 Subject: [PATCH] =?UTF-8?q?chore:=20=F0=9F=94=A7=20Update=20docstring=20gu?= =?UTF-8?q?idelines=20for=20typing=20usage?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit - Added clarification to the docstring guidelines to include the use of `typing` in docstrings. --- .github/copilot-instructions.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/copilot-instructions.md b/.github/copilot-instructions.md index 0604a99..f10cd46 100644 --- a/.github/copilot-instructions.md +++ b/.github/copilot-instructions.md @@ -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.