Review of the project status, documentation, and code.

[ll7]

https://digicampus.uni-augsburg.de/dispatch.php/course/scm/acc5369af022d5ed4e19af0befdc7153?cid=53e41a88f521da0b4d9ccdd9fc7cec27

Ziel:

• schnelle Einarbeitung
• Wiederverwendbarkeit
  Inline:
• was gemacht wird (wenn nicht eindeutig aus dem naming hervor geht)
• wie etwas gemacht wird
• Funktionen & Klassen
  • docstrings
    • in und output
      Extern: im Wiki oder Docs Folder (verlinken aus dem Readme)
• Installationsanleitung und Systemvoraussetzungen
• Beispiel Verwendung
• Übersicht über den Programmablauf/-aufbau
  • Darstellung der Zusammenhänge der Subpakete
    • https://github.com/ll7/psaf1/blob/master/docs/modules_diagram.png
    • https://github.com/ll7/psaf2/blob/main/documentation/package_overview.svg
  • Aufgabenübersicht der Subpakete
    • Program XY hat diese Aufgabe und diese Ein- und Ausgänge
  • Warum etwas so gemacht wird
• Pakete dokumentieren
  • Warum etwas so gemacht wird
    • Hintergrundinformationen und Überlegungen
  • Schnittstellen und Abhängigkeiten
  • Funktionsumfang
• Known Issues
  • Idealerweise mit Vermutung oder Begründung der Ursache und Hinweisen zu Future Work.

[ll7]

Setup

https://github.com/ll7/paf21-2/blob/b49108098ff5688477e85cebbc710126ef095bda/scripts/setup.sh

downloads and installs carla always? No check, if it already exists.

[ll7]

Bewertung

[ll7]

Inline documentation

perception

• https://github.com/ll7/paf21-2/blob/6b02d6361cf3a7108ef8698b9802bf5328d87757/paf_ros/paf_perception/src/semantic_lidar.py#L15
• https://github.com/ll7/paf21-2/blob/6b02d6361cf3a7108ef8698b9802bf5328d87757/paf_ros/paf_perception/src/semantic_lidar.py#L207

planning

• https://github.com/ll7/paf21-2/blob/793c940cfef681916d1c4f16d975ce69b72bb58c/paf_ros/paf_planning/src/classes/LocalPath.py#L377
• https://github.com/ll7/paf21-2/blob/793c940cfef681916d1c4f16d975ce69b72bb58c/paf_ros/paf_planning/src/classes/LocalPath.py#L392