Merge remote-tracking branch 'origin/main'

Monarch-Robotics-1245 · Oct 24, 2024 · 3209573 · 3209573
2 parents 046a41c + 5c96c8f
commit 3209573
Show file tree

Hide file tree

Showing 5 changed files with 16 additions and 0 deletions.
diff --git a/.gitignore b/.gitignore
@@ -1,3 +1,4 @@
 #GITIGNORE
 .program.py
 .idea/*
+.vscode/settings.json
diff --git a/README.md b/README.md
@@ -8,6 +8,8 @@
 ![Pull Requests](https://img.shields.io/endpoint?url=https://monarchlowg-private-repo-badges-23423423.vercel.app/api/fetchRepoData?type=pull-requests&cacheSeconds=10)
 [![CI Workflow](https://github.com/Monarch-Robotics-1245/BEST-LowG/actions/workflows/ci.yml/badge.svg)](https://github.com/Monarch-Robotics-1245/BEST-LowG/actions/workflows/ci.yml)
 
+[![Static Badge](https://img.shields.io/badge/PyDoc_Documentation-Online?color=green&link=https%3A%2F%2Fbest-low-g-docs.vercel.app%2F)](https://best-low-g-docs.vercel.app/)
+
 # BEST LowG
 ## **Description**
 Monarch Robotics code for the 2024 BEST LowG Season

diff --git a/src/main.py b/src/main.py
@@ -13,6 +13,8 @@
 
 def robot(leftMotor, rightMotor, motorOne, motorTwo, servoOne, servoTwo, servoThree, servoFour, digitalOne, digitalTwo, digitalThree, digitalFour, digitalFive, digitalSix, digitalSeven, digitalEight, digitalNine, driveFwd, driveSide, dbgUp, dbgDown, previousDbgDown, previousDbgUp, grip, release, previousGrip, previousRelease, towerAxis, lastPosition, lastPositionSet, turretAxis, analogOne, wristDown, wristUp, previousWristDown, previousWristUp, turretUp, previousTurretUp, previousTurretDown, turretDown, modeToggle, previousModeToggle, state, targetPosition, autoAButton, previousAutoAButton, autoBButton, previousAutoBButton, autoID, reverseButton, previousReverseButton, speedButton, previousSpeedButton, speedMultiplier, direction, autoStage):
     # 0 (not pressed) and 1(pressed) - not True and False for buttons
+
+    #if ok
     if digitalEight == 1:
         allowedStates = 1
     else:

diff --git a/src/subsystems/drivetrain.py b/src/subsystems/drivetrain.py
@@ -29,8 +29,16 @@
 
 
 def setLeftMotor(value):
+    """
+    set left motor to the value provided
+    value (int): the value that the left motor is set to
+    """
     leftMotor = value
 
 
 def setRightMotor(value):
+    """
+    set right motor to the value provided
+    value (int): the value that the right motor is set to
+    """
     rightMotor = value
diff --git a/src/subsystems/gripper.py b/src/subsystems/gripper.py
@@ -29,6 +29,9 @@
 
 
 def openGripper():
+    """
+    sets gripper to be open
+    """
     servoOne = src.constants.gripper.GRIPPER_OPEN
-Original file line number
+Diff line change
@@ Expand Up / @@ -29,6 +29,9 @@ @@
     def openGripper():
+        """
+        sets gripper to be open
+        """
         servoOne = src.constants.gripper.GRIPPER_OPEN
@@ Expand Down @@