-
Notifications
You must be signed in to change notification settings - Fork 120
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
Fix: Pythonドキュメント周りの色々を修正 #570
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.
LGTM!!!
ありがとうございます!!
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.
今更ですが、Rust/C/Pythonで表現が不必要に異なっている箇所が(このPR前の時点から)そこそこあるように思えました。統一できるならできるだけしていった方がよいと思いました。
"""単語の優先度。 | ||
|
||
0から10までの整数。 | ||
数字が大きいほど優先度が高くなる。 | ||
1から9までの値を指定することを推奨する。 | ||
""" |
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.
""" | ||
@property | ||
def words(self) -> Dict[UUID, UserDictWord]: | ||
"""単語のDict。""" |
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.
:class:`dict`
みたいな表現にした方がよいかなと思いました。
私が表現するならこうでしょうか。
"""単語のDict。""" | |
"""このオプジェクトの :class:`dict` としての表現。""" |
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.
今気付いたのですが、更新を意図してこのwords
に__setitem__
するユーザーが現れる気がしました。
to_dict
みたいな名前にするか、あるいはこの@property
はやめて__iter__
を付けてdict(userdict)
とできるようにするかした方がよいかもしれません。
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.
collections.abc.Mappingを継承するのが良さそうに思えました。
Co-authored-by: Ryo Yamashita <[email protected]>
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!
内容
__init__
がおかしかったので修正しました。関連 Issue
その他
逆にreSTに統一しても良かったかも?