-
Notifications
You must be signed in to change notification settings - Fork 205
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
修正: API 関数 docstring を FastAPI 型に変更 #1123
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
変更ありがとうございます、すごくいいと思います!!
run.pyを確認したところ、まだ結構Numpyっぽくなっているドキュメントが残ってるかもでした。
-------
でファイル内検索すると分かりやすかったです!
@Hiroshiba |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM!!!
ソースコードとして見た時、Anoatedで引数のドキュメントを書いていくとわりと読むのが難しくなるなと感じました!
仕方ないかもですが、他の方法があればそっちの方を取りたいかもですね!
"allOf": [ | ||
{ | ||
"$ref": "#/components/schemas/WordTypes" | ||
} | ||
], |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
openapi.jsonがこんな感じで変わってるとこがちらほらありました。
なんで変わってるのかわからないけど、挙動的に一緒な気がしますし、テスト通ってるし問題なさそうですかね・・・?
内容
API 関数 docstring を FastAPI 型に変更し、ドキュメントの崩れを修正した。
関連 Issue
resolve #719
スクリーンショット・動画など
API docs の改善