APIが投げうるエラーについて網羅的にまとめてAPIドキュメントに書く

[qryxip]

内容

各APIドキュメントに、APIが投げうるエラーについて網羅的にまとめます。

Pros 良くなる点

• APIドキュメントとしてのわかりやすさの向上

Cons 悪くなる点

• 手間

実現方法

調べ、書く。

VOICEVOXのバージョン

N/A

OSの種類/ディストリ/バージョン

• Windows
• macOS
• Linux

その他

##532 でやるつもりでした。

[Hiroshiba]

issue作成ありがとうございます！

これってC APIの話だと思うのですが、タイトルにそのように含めておくと終了条件が分かりやすいかなと思いました！
もし全てのAPIの話だとおそらく相当解決が困難なので、小分けにしておくとちょっとやりやすいかもです！

[qryxip]

こちらもRust/C/Python全部に対してを意図していました。Rustdocの# ErrorsとSphinxの:raises:を埋める形です。

段取りとしてはまずRust APIのエラーを全部調べて# Errorsにまとめ、それからC/Python APIのものを書くことを考えています。あまり多くないし、大丈夫なのではと思っています。

❯ rg Error:: ./crates/voicevox_core -c
./crates/voicevox_core/src/voice_synthesizer.rs:1
./crates/voicevox_core/src/voice_model.rs:7
./crates/voicevox_core/src/devices.rs:1
./crates/voicevox_core/src/status.rs:12
./crates/voicevox_core/src/inference_core.rs:4
./crates/voicevox_core/src/user_dict/dict.rs:6
./crates/voicevox_core/src/user_dict/word.rs:9
./crates/voicevox_core/src/engine/open_jtalk.rs:12
./crates/voicevox_core/src/engine/full_context_label.rs:4

[Hiroshiba]

なるほどです！
示されているのはエラーを発生させる関数の数でしょうか。便利。

今どの言語のエラーがすでにドキュメントになっているかかを他の人がすぐに確認できるようにしておくと、進捗度が分かって参加しやすかったりしていいのかなぁとちょっと思いました。
issueを分けておけば、誰かが取り組みたいと思った時に手をつけやすいかも･･･？
あるいはRust``C``Pythonと言語のリストだけ書いてタスクリストとして一番上で案内するとか･･･？