__doc__ strings #13

New Issue

winterhalderp · 2023-02-28T15:59:49+01:00

winterhalderp commented

2023-02-28 15:59:49 +01:00

c1d9c6e33c/src/pubsub/pubsub/pubsub_library_v3.py (L42)

Alle Funktionen mit __doc__ strings versehen, sodass einfacher verständlich.

Zudem Beispiele schreiben, wie Bibliothek verwendet werden soll.

Services und Actions: Jeweils neue Klasse definieren, zb. class Servo() und MinimalActionServer vererben, zb.:

class Servo(MinimalActionServer):
    __init__(*params)
    (Initialisiert Action Server super().__init__)
    
    action_goal_callback(*params)
    (Überschreibt std_action_callback aus super())
    
    feedback_callback(*params)
    (Überschreibt str_feedback_callback aus super())

https://egit.irs.uni-stuttgart.de/RoverLehre/ROS2_pubsub/src/commit/c1d9c6e33ce41323c06ccbfe695696d46f5bd77a/src/pubsub/pubsub/pubsub_library_v3.py#L42 Alle Funktionen mit `__doc__` strings versehen, sodass einfacher verständlich. Zudem Beispiele schreiben, wie Bibliothek verwendet werden soll. Services und Actions: Jeweils neue Klasse definieren, zb. `class Servo()` und `MinimalActionServer` vererben, zb.: ``` class Servo(MinimalActionServer): __init__(*params) (Initialisiert Action Server super().__init__) action_goal_callback(*params) (Überschreibt std_action_callback aus super()) feedback_callback(*params) (Überschreibt str_feedback_callback aus super()) ```

Sign in to join this conversation.

No Label

No Milestone

No project

No Assignees

1 Participants

Notifications

Due Date

The due date is invalid or out of range. Please use the format 'yyyy-mm-dd'.

No due date set.

Dependencies

No dependencies set.

Reference: RoverLehre/ROS2_pubsub#13