Skip to content

docs: add missed doc strings#264

Merged
Apricot-S merged 1 commit intomasterfrom
add-missed-docs
Mar 30, 2026
Merged

docs: add missed doc strings#264
Apricot-S merged 1 commit intomasterfrom
add-missed-docs

Conversation

@Nihisil
Copy link
Copy Markdown
Contributor

@Nihisil Nihisil commented Mar 30, 2026

#121

I did final checks and noticed that https://mahjongrepository.github.io/mahjong/modules/hand_calculating/yaku.html# is not being rendered correctly (there is no yaku/__init__.py info here). I think it is because yaku.py didn't have module level doc.

@Nihisil Nihisil added this to the v2.0.0 milestone Mar 30, 2026
@Nihisil Nihisil requested a review from Apricot-S as a code owner March 30, 2026 14:17
@Apricot-S Apricot-S merged commit 57bb938 into master Mar 30, 2026
11 checks passed
@Apricot-S Apricot-S deleted the add-missed-docs branch March 30, 2026 14:31
@Nihisil
Copy link
Copy Markdown
Contributor Author

Nihisil commented Mar 30, 2026

@Apricot-S it is still not rendered 🫠 https://mahjongrepository.github.io/mahjong/modules/hand_calculating/yaku.html

but I guess it is minor issue and can be fixed later

@Apricot-S
Copy link
Copy Markdown
Collaborator

@Nihisil
It looks normal on my environment, but how about yours?

image

@Apricot-S
Copy link
Copy Markdown
Collaborator

The yaku/__init__.py file does not exist, and the Yaku.__init__() method is not defined, so it will not be rendered.

Where are you referring to?

@Nihisil
Copy link
Copy Markdown
Contributor Author

Nihisil commented Mar 30, 2026

@Apricot-S thanks for checking, all good now. I just checked wrong thing

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.

2 participants