Skip to content

add top/front side explanation to docstrings of Hub constructors #171

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
kai-morich wants to merge 1 commit into
base: master
Choose a base branch
from
+12 −12
Open

add top/front side explanation to docstrings of Hub constructors #171

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
24 changes: 12 additions & 12 deletions src/pybricks/hubs.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -123,10 +123,10 @@ def __init__(
(with the light) are pointing.

Arguments:
top_side (Axis): The axis that passes through the *top side* of
the hub.
front_side (Axis): The axis that passes through the *front side* of
the hub.
top_side (Axis): The axis that passes through the *top side*
(with the button) of the hub.
front_side (Axis): The axis that passes through the *front side*
(with the light) of the hub.
broadcast_channel:
Channel number (0 to 255) used to broadcast data.
Choose ``None`` when not using broadcasting.
Expand Down Expand Up @@ -168,10 +168,10 @@ def __init__(
port, and I/O ports A and B) are pointing.

Arguments:
top_side (Axis): The axis that passes through the *top side* of
the hub.
front_side (Axis): The axis that passes through the *front side* of
the hub.
top_side (Axis): The axis that passes through the *top side*
(with the button) of the hub.
front_side (Axis): The axis that passes through the *front side*
(with the USB port, and I/O ports A and B) of the hub.
broadcast_channel:
Channel number (0 to 255) used to broadcast data.
Choose ``None`` when not using broadcasting.
Expand Down Expand Up @@ -223,10 +223,10 @@ def __init__(
port) are pointing.

Arguments:
top_side (Axis): The axis that passes through the *top side* of
the hub.
front_side (Axis): The axis that passes through the *front side* of
the hub.
top_side (Axis): The axis that passes through the *top side*
(with the buttons) of the hub.
front_side (Axis): The axis that passes through the *front side*
(with the USB port) of the hub.
broadcast_channel:
Channel number (0 to 255) used to broadcast data.
Choose ``None`` when not using broadcasting.
Expand Down
Loading