$ARGUMENTS を、このコードベースに不慣れなエンジニア向けに説明します。
パスやシンボルが指定されていない場合は、どれを説明するか質問してから停止します。
- 対象を読み込みます。それがどこで使用されているか(インポート/呼び出し元を検索)と、それが依存しているものを特定します。
- 以下の形式で説明を記述します。
- 目的: 平易な言葉で1~2文。
- 位置づけ: 誰がそれを呼び出すか、それが何を呼び出すか、リクエスト/データフロー内のどこに位置するか。
- 主要部分: 最も重要な3~6個の関数、クラス、またはセクション。それぞれ1行で説明。
- 注意点: 非自明な動作、副作用、エラーケース、パフォーマンス上の問題。
- 変更を加える場合の開始点: 最初に開くべきファイルと関数、およびそれをカバーするテスト。
- ファイルパスと行番号を引用します(例:
path/to/file.py:42)。読者がそこにジャンプできるようにします。
事実に基づいて記述します。コードから不明瞭な点がある場合は、推測せずにその旨を明記します。ファイルを変更してはいけません。