docs: add docstrings for `RPA`

[Cryolite]

関数・クラス・メソッドに対する docstring を書き始めたので first try として PR を出します． docstring のスタイルはとりあえず Google のもの (https://google.github.io/styleguide/pyguide.html#38-comments-and-docstrings) を採用していますが，他のスタイルが良いなどあればコメントお願いします．

[Apricot-S]

関数・クラス・メソッドに対する docstring を書き始めたので first try として PR を出します． docstring のスタイルはとりあえず Google のもの (https://google.github.io/styleguide/pyguide.html#38-comments-and-docstrings) を採用していますが，他のスタイルが良いなどあればコメントお願いします．

ありがとうございます。 Cryoliteさんの感覚でよいのですが、 機械学習界隈ではreStructuredTextスタイル・Googleスタイル・NumPyスタイルのどれが主流でしょうか? それに合わせたいと思います。

[Cryolite]

ありがとうございます。 Cryoliteさんの感覚でよいのですが、 機械学習界隈ではreStructuredTextスタイル・Googleスタイル・NumPyスタイルのどれが主流でしょうか? それに合わせたいと思います。

Python で機械学習というとやはり PyTorch でしょうね．あれは何のスタイルだろう……． Google に近いけれど微妙に違うような？ @smly にも聞いてみたいところ．

[Apricot-S]

あとdocstringはコメントと同じく1行72文字以内でお願いします(PEP8)。

そろそろpyproject.tomlにruffのdocstring関係の設定を追加した方がよいかもしれませんね。

[smly]

昔はnumpyスタイルに慣れていたのですが最近はGoogleスタイルをよく見ます。PyTorch は Google スタイル+α と書かれていますね。もうこれで良いのではないかと思いました。 https://github.com/pytorch/pytorch/blob/main/CONTRIBUTING.md#writing-documentation

docstringのスタイルにおける line-length と pep8 の line-length はルールが競合しますが、運用しやすければどちらでも良いと考えています。72文字以内について異論ないです。

[Cryolite]

昔はnumpyスタイルに慣れていたのですが最近はGoogleスタイルをよく見ます。PyTorch は Google スタイル+α と書かれていますね。もうこれで良いのではないかと思いました。 https://github.com/pytorch/pytorch/blob/main/CONTRIBUTING.md#writing-documentation

これで良さそうですね．

docstringのスタイルにおける line-length と pep8 の line-length はルールが競合しますが、運用しやすければどちらでも良いと考えています。72文字以内について異論ないです。

ruff はコードの line-length と docstring の line-length を別に指定できるっぽいので，その指定を追加しましょう．

[Cryolite]

• docstring の1行あたりの文字数に対する Ruff の設定を追加しました．
• 全体的にドキュメントを校正しました．

[Cryolite]

docstring に対する Ruff の設定を修正・追加しました．