修正: API 関数 docstring を FastAPI 型に変更

[tarepan]

内容

API 関数 docstring を FastAPI 型に変更し、ドキュメントの崩れを修正した。

関連 Issue

resolve #719

スクリーンショット・動画など

API docs の改善

[github-actions]

Coverage Result

Resultを開く

Name	Stmts	Miss	Cover
run.py	515	209
voicevox_engine/init.py	1	0
voicevox_engine/cancellable_engine.py	94	72
voicevox_engine/core/init.py	0	0
voicevox_engine/core/core_adapter.py	81	6
voicevox_engine/core/core_initializer.py	60	30
voicevox_engine/core/core_wrapper.py	225	157
voicevox_engine/dev/init.py	0	0
voicevox_engine/dev/core/init.py	0	0
voicevox_engine/dev/core/mock.py	65	2
voicevox_engine/dev/tts_engine/init.py	0	0
voicevox_engine/dev/tts_engine/mock.py	28	0
voicevox_engine/engine_manifest/EngineManifest.py	36	0
voicevox_engine/engine_manifest/EngineManifestLoader.py	12	0
voicevox_engine/engine_manifest/init.py	0	0
voicevox_engine/library_manager.py	92	4
voicevox_engine/metas/Metas.py	36	0
voicevox_engine/metas/MetasStore.py	28	1
voicevox_engine/metas/init.py	0	0
voicevox_engine/model.py	180	3
voicevox_engine/morphing.py	71	4
voicevox_engine/preset/Preset.py	13	0
voicevox_engine/preset/PresetError.py	2	0
voicevox_engine/preset/PresetManager.py	80	2
voicevox_engine/preset/init.py	0	0
voicevox_engine/setting/Setting.py	9	0
voicevox_engine/setting/SettingLoader.py	20	0
voicevox_engine/setting/init.py	0	0
voicevox_engine/tts_pipeline/init.py	0	0
voicevox_engine/tts_pipeline/kana_converter.py	88	1
voicevox_engine/tts_pipeline/mora_mapping.py	7	0
voicevox_engine/tts_pipeline/phoneme.py	34	0
voicevox_engine/tts_pipeline/text_analyzer.py	146	6
voicevox_engine/tts_pipeline/tts_engine.py	267	9
voicevox_engine/user_dict/part_of_speech_data.py	5	0
voicevox_engine/user_dict/user_dict.py	146	12
voicevox_engine/utility/init.py	0	0
voicevox_engine/utility/connect_base64_waves.py	37	0
voicevox_engine/utility/core_utility.py	6	0
voicevox_engine/utility/core_version_utility.py	8	1
voicevox_engine/utility/mutex_utility.py	13	0
voicevox_engine/utility/path_utility.py	26	6
voicevox_engine/utility/run_utility.py	10	7
TOTAL	2441	532

[Hiroshiba]

変更ありがとうございます、すごくいいと思います！！

run.pyを確認したところ、まだ結構Numpyっぽくなっているドキュメントが残ってるかもでした。
-------でファイル内検索すると分かりやすかったです！

[tarepan]

@Hiroshiba
全指摘箇所の反映・テストパスを確認しました。Re-review よろしくお願いします。

[Hiroshiba]

LGTM！！！

ソースコードとして見た時、Anoatedで引数のドキュメントを書いていくとわりと読むのが難しくなるなと感じました！
仕方ないかもですが、他の方法があればそっちの方を取りたいかもですね！

[Hiroshiba]

openapi.jsonがこんな感じで変わってるとこがちらほらありました。
なんで変わってるのかわからないけど、挙動的に一緒な気がしますし、テスト通ってるし問題なさそうですかね･･･？