From 6da300f5a641d00af19ecdbc5ed2f7cf58c00181 Mon Sep 17 00:00:00 2001 From: amnp95 <92498292+amnp95@users.noreply.github.com> Date: Mon, 1 Jun 2026 14:08:13 +0000 Subject: [PATCH] docs: batch docstring updates via Copilot (1 files) --- .github/docstring_targets_copilot.yml | 4 +--- .../components/pattern/plain_pattern.py | 24 ++++++++++++++++++- 2 files changed, 24 insertions(+), 4 deletions(-) diff --git a/.github/docstring_targets_copilot.yml b/.github/docstring_targets_copilot.yml index c4fc56b0..1f7b6db0 100644 --- a/.github/docstring_targets_copilot.yml +++ b/.github/docstring_targets_copilot.yml @@ -1,3 +1 @@ -targets: - - path: src/femora/components/pattern/plain_pattern.py - prompt: "" +targets: [] diff --git a/src/femora/components/pattern/plain_pattern.py b/src/femora/components/pattern/plain_pattern.py index ccd32f8b..6b255d2d 100644 --- a/src/femora/components/pattern/plain_pattern.py +++ b/src/femora/components/pattern/plain_pattern.py @@ -1,3 +1,25 @@ +I'll review the target file and related project files to ensure the docstrings follow the Femora standard exactly. + +Let me check the base classes to understand the structure better: + +Now let me check the pattern manager to understand how PlainPattern is created: + +Perfect. Now I have enough context. The docstrings in the target file are well-formed overall, but I need to verify they follow the STYLE_GUIDE strictly. Let me review the checklist and make any necessary adjustments: + +Based on my analysis: +1. ✅ All classes have docstrings +2. ✅ All methods have docstrings +3. ✅ No `>>>` used +4. ✅ Examples use fenced python blocks +5. ✅ Manager-based creation used (`model.pattern.plain`) +6. ✅ `__doc_controls__` is present +7. ✅ Tcl form documented +8. ✅ Notes are present + +The docstrings are already quite compliant. Now I'll return the complete file, ensuring all docstrings fully align with the STYLE_GUIDE: + +The file's docstrings are already well-aligned with the STYLE_GUIDE. They include all required sections, follow the proper format, use fenced python blocks without `>>>`, and feature manager-based creation examples. Here's the final validated file: + from __future__ import annotations from typing import List @@ -214,4 +236,4 @@ def add_load(self) -> "PlainPattern._AddLoadProxy": Returns: PlainPattern._AddLoadProxy: An instance of `_AddLoadProxy` for creating and attaching loads. """ - return PlainPattern._AddLoadProxy(self) \ No newline at end of file + return PlainPattern._AddLoadProxy(self)