Erkläre $ARGUMENTS einem Entwickler, der neu in dieser Codebase ist.
Falls kein Pfad oder Symbol angegeben wurde, frage nach welchem und stoppe.
- Lies das Ziel. Finde heraus, wo es verwendet wird (suche nach Importen/Aufrufern) und wovon es abhängt.
- Schreibe die Erklärung in dieser Form:
- Zweck: ein oder zwei Sätze in einfacher Sprache.
- Einbettung: wer ruft es auf, was ruft es auf, wo befindet es sich im Anfrage-/Datenfluss.
- Schlüsselkomponenten: die 3–6 wichtigsten Funktionen, Klassen oder Abschnitte, jeweils mit einem Satz.
- Fallstricke: nicht offensichtliches Verhalten, Seiteneffekte, Fehlerfälle, Performance-Fallen.
- Wo du anfangen solltest, wenn du es ändern musst: die Datei und Funktion, die du zuerst öffnen solltest, sowie die Tests, die sie abdecken.
- Zitiere Dateipfade mit Zeilennummern (
pfad/zu/datei.py:42), damit der Leser direkt dorthin springen kann.
Bleibe sachlich. Wenn etwas aus dem Code nicht klar hervorgeht, sage das, anstatt zu raten. Ändere keine Dateien.