Skip to content

Improve docstring for get_axis_items_guids function #304

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
usai-sylvain wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Improve docstring for get_axis_items_guids function #304

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4db594b
Improve docstring for get_axis_items_guids function
usai-sylvain Jan 22, 2026
a3f1303
Merge pull request #1 from usai-sylvain/301-connector_axis_items_doc
usai-sylvain Jan 22, 2026
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
7 changes: 5 additions & 2 deletions src/connector_axis_controller/__init__.pyi
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -190,8 +190,11 @@ def get_section_diameter(axis_id: ElementId, section_index: UnsignedInt) -> floa


def get_axis_items_guids(axis_id: ElementId) -> List[str]:
"""Returns a list of GUIDs of all axis items.

"""Returns a list of GUIDs of all items contained by this connector axis.

Axis items include nuts, washers, bolts, and other hardware components
defined in cadwork.vba_catalog_item_type.

Parameters:
axis_id: The id of the axis.

Expand Down