added german documentation to seeding and double elimination api/ gamestate

This commit is contained in:
Joel Klimont 2022-11-09 03:25:27 +01:00
parent de9b671f29
commit 369692b619
8 changed files with 107 additions and 24 deletions

View file

@ -23,14 +23,14 @@ API_URL_GET_ROBOT_STATE = API_URL + "getRobotState"
class Seeding:
"""Class used for communicating with seeding api
"""Klasse welche mit der Seeding API Kommuniziert.
"""
@staticmethod
def get_heuballen() -> int:
"""Makes the /api/getHeuballen call to the api.
"""Macht den /api/getHeuballen request zur Seeding API.
:return: hueballencode as int.
:return: hueballencode als int.
:rtype: int
"""
res = requests.get(API_URL_GET_HEU)
@ -40,9 +40,9 @@ class Seeding:
@staticmethod
def get_logistic_plan() -> List:
"""Makes the /api/getLogisticPlan call to the api.
"""Macht den /api/getLogisticPlan zur Seeding API.
:return: Json Object and status code as returned by the api.
:return: Liste an logistic-centern, welche vom roboter in genau der Reihenfolge beliefert werden sollten.
:rtype: List
"""
res = requests.get(API_URL_GET_LOGISTIC_PLAN)
@ -52,7 +52,7 @@ class Seeding:
@staticmethod
def get_material_deliveries() -> List:
"""Makes the /api/getMaterialDeliveries call to the api.
"""Macht den /api/getMaterialDeliveries zur Seeding API.
:return: Json Object and status code as returned by the api.
:rtype: List