コードを自動改善する

CodeRabbit の強力な機能には、問題を特定するだけでなく、修正に必要なコード変更を自動で生成する機能があります。レビューの提案を手動で実装する代わりに、CodeRabbit に実施させることができます。

このステップでは、CodeRabbit コマンドを使って Python コードのドキュメントを自動改善します。

ドキュメント文字列を自動生成する

プル リクエストに以下のコメントを投稿します。

このコマンドで、CodeRabbit がコードを解析し、すべての関数にドキュメント文字列を生成します。

CodeRabbit が実行すること

しばらくすると、CodeRabbit は自動的に以下のアクションを実行します。

生成された変更を確認する

CodeRabbit が新しいプル リクエストを作成したら:

1. 新しいプル リクエストに移動する
2. 生成されたドキュメントを確認する
3. docstring が各関数を正確に説明しているか確認する
4. 基準を満たしていればマージする

その他の利用可能なコマンド

CodeRabbit はコード改善を支援する多くのコマンドに対応しています。