モジュールの名称・内容・docstring に一貫性を持たせる #1632
Description
内容
「モジュールの名称・内容・docstring に一貫性を持たせられているか」を検証し改善することを提案します。
VOICEVOX ENGINE は順調に成長し機能拡張してきた裏返しとして、一部実装がツギハギになっている。
具体的には、別件のリファクタリング中に、モジュールの名称・内容・docstring に一貫性が無い可能性が示唆された（#1619 (comment) ）。
VOICEVOX ENGINE レポジトリは単体テストを採用しているため、voicevox_engine/ 下の各モジュールに test_同名.py の unit test が用意されている（ことが多い）。
そのためモジュール名が A、実際の内容が B の場合、以下のようなズレが発生する：
A.pyなのに中身は B が実装されているA.pyなのに docstring は B について書いてあるtest_A.pyなのに中身は B がテストされてあるtest_A.pyなのに docstring は B について書いてある
これは特に新規コントリビューターの混乱を招くため、リファクタリングが必要である。
このような背景から、「モジュールの名称・内容・docstring に一貫性を持たせられているか」を検証し改善することを提案します。
Pros 良くなる点
- 一貫性向上による検索性・可読性の向上
Cons 悪くなる点
無し
実現方法
- 矛盾探し
- 改名
ただし「モジュール内のクラス名が（ツギハギの結果）実体と乖離し始めている」というケースまでありそうなので、影響範囲は実際に手を動かすまでわからなそうです。