Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 1 addition & 3 deletions .github/docstring_targets_copilot.yml
Original file line number Diff line number Diff line change
@@ -1,3 +1 @@
targets:
- path: src/femora/components/pattern/plain_pattern.py
prompt: ""
targets: []
24 changes: 23 additions & 1 deletion src/femora/components/pattern/plain_pattern.py
Original file line number Diff line number Diff line change
@@ -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
Expand Down Expand Up @@ -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)
return PlainPattern._AddLoadProxy(self)