Skip to content
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

Merged
merged 5 commits into from
Aug 23, 2023

Conversation

sevenc-nanashi
Copy link
Member

@sevenc-nanashi sevenc-nanashi commented Aug 6, 2023

内容

  • ユーザー辞書の__init__がおかしかったので修正しました。
  • UserDictWord、UserDictWordTypeのドキュメントを追加しました。
  • テストがドキュメントされるのを修正しました。
  • ドキュメントをNumpy記法で統一しました。
    • ドキュメント生成のためにnapoleonを拡張に入れました。標準付属のためrequirementsは変わっていません。

関連 Issue

その他

逆にreSTに統一しても良かったかも?

@sevenc-nanashi sevenc-nanashi changed the title Fix: ドキュメント周りの色々を修正 Fix: Pythonドキュメント周りの色々を修正 Aug 6, 2023
Copy link
Member

@Hiroshiba Hiroshiba left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!!!

ありがとうございます!!

Copy link
Member

@qryxip qryxip left a 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前の時点から)そこそこあるように思えました。統一できるならできるだけしていった方がよいと思いました。

Comment on lines 212 to 217
"""単語の優先度。

0から10までの整数。
数字が大きいほど優先度が高くなる。
1から9までの値を指定することを推奨する。
"""
Copy link
Member

@qryxip qryxip Aug 8, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

細かいのですが、「高くなる。」と「1から9」の間だけ0x20が入るようになっているみたいです。

image

おそらく行頭がASCII文字?だとスペースが入るようになっています。

    あああああ
    いいいいい
    ううううう
    aえええええ
    bおおおおお

image

まあ気になる人がどれだけいるかという話になりますが...

(追記) 試したらGitHubもRustdocも同様でした。

"""
@property
def words(self) -> Dict[UUID, UserDictWord]:
"""単語のDict。"""
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

:class:`dict`みたいな表現にした方がよいかなと思いました。

私が表現するならこうでしょうか。

Suggested change
"""単語のDict。"""
"""このオプジェクトの :class:`dict` としての表現。"""

Copy link
Member

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)とできるようにするかした方がよいかもしれません。

Copy link
Member Author

@sevenc-nanashi sevenc-nanashi Aug 8, 2023

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]>
@sevenc-nanashi
Copy link
Member Author

sevenc-nanashi commented Aug 8, 2023

image

そういえば:左上、結構カスタマイズできそうでした。こんな感じにしても良いかも?

Copy link
Member

@qryxip qryxip left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

@qryxip qryxip merged commit 27aa840 into VOICEVOX:main Aug 23, 2023
qryxip added a commit to qryxip/voicevox_core that referenced this pull request Sep 22, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants