Skip to content

Commit 28abebe

Browse files
committed
Updated doc comments to match official branding
1 parent 31f4a18 commit 28abebe

14 files changed

+15
-14
lines changed

.gitignore

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,4 +5,5 @@ docs/_build/
55
.picowgo
66
secrets.json
77
venv
8-
.temp_xrplib
8+
.temp_xrplib
9+
XRPLib/__pycache__
-193 Bytes
Binary file not shown.
-5.54 KB
Binary file not shown.
Binary file not shown.
-8.49 KB
Binary file not shown.
-5.32 KB
Binary file not shown.

XRPLib/board.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ def get_default_board(cls):
1919
def __init__(self, vin_pin="BOARD_VIN_MEASURE", button_pin="BOARD_USER_BUTTON",
2020
rgb_led_pin = "BOARD_NEOPIXEL", led_pin = "LED"):
2121
"""
22-
Implements for extra features on the XRP v2 board. Handles the on/off switch, button, and LED.
22+
Implements for extra features on the XRP board. Handles the on/off switch, button, and LED.
2323
2424
:param vin_pin: The pin the on/off switch is connected to
2525
:type vin_pin: int
@@ -114,4 +114,4 @@ def set_rgb_led(self, r:int, g:int, b:int):
114114
self.rgb_led[0] = (r, g, b)
115115
self.rgb_led.write()
116116
else:
117-
raise NotImplementedError("Board.set_rgb_led not implemented for the XRP RP2040")
117+
raise NotImplementedError("Board.set_rgb_led not implemented for the XRP Beta")

XRPLib/differential_drive.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ class DifferentialDrive:
1414
def get_default_differential_drive(cls):
1515

1616
"""
17-
Get the default XRP v2 differential drive instance. This is a singleton, so only one instance of the drivetrain will ever exist.
17+
Get the default XRP differential drive instance. This is a singleton, so only one instance of the drivetrain will ever exist.
1818
"""
1919

2020
if cls._DEFAULT_DIFFERENTIAL_DRIVE_INSTANCE is None:

XRPLib/encoded_motor.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ class EncodedMotor:
1818
@classmethod
1919
def get_default_encoded_motor(cls, index:int = 1):
2020
"""
21-
Get one of the default XRP v2 motor instances. These are singletons, so only one instance of each of these will ever exist.
21+
Get one of the default XRP motor instances. These are singletons, so only one instance of each of these will ever exist.
2222
Raises an exception if an invalid index is requested.
2323
2424
:param index: The index of the motor to get; 1 for left, 2 for right, 3 for motor 3, 4 for motor 4

XRPLib/imu.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ class IMU():
1919
@classmethod
2020
def get_default_imu(cls):
2121
"""
22-
Get the default XRP v2 IMU instance. This is a singleton, so only one instance of the drivetrain will ever exist.
22+
Get the default XRP IMU instance. This is a singleton, so only one instance of the drivetrain will ever exist.
2323
"""
2424

2525
if cls._DEFAULT_IMU_INSTANCE is None:

0 commit comments

Comments
 (0)