Skip to content

docs: add hand config documentation#244

Open
Nihisil wants to merge 1 commit intomasterfrom
add-hand-config-doc
Open

docs: add hand config documentation#244
Nihisil wants to merge 1 commit intomasterfrom
add-hand-config-doc

Conversation

@Nihisil
Copy link
Contributor

@Nihisil Nihisil commented Mar 5, 2026

#121

add hand config doc and fix few inconsistencies in already added doc files

@Nihisil Nihisil added this to the v2.0.0 milestone Mar 5, 2026
@Nihisil Nihisil requested a review from Apricot-S as a code owner March 5, 2026 02:53
@Nihisil Nihisil force-pushed the add-hand-config-doc branch from e5d7b04 to d4be7c8 Compare March 5, 2026 12:46
:attr:`HandConstants.KAZOE_LIMITED`, :attr:`HandConstants.KAZOE_SANBAIMAN`,
or :attr:`HandConstants.KAZOE_NO_LIMIT`
:vartype kazoe_limit: int
:ivar kiriage: round up to mangan when han/fu are at the boundary (e.g. 4 han 30 fu)
Copy link
Collaborator

Choose a reason for hiding this comment

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

Since the only targets for kiriage mangan are 30 fu 4 han and 60 fu 3 han, it is better to explicitly list them. (120 fu always includes sankantsu, so it becomes mangan.)

:ivar kiriage: round up to mangan when han/fu are at the boundary (e.g. 4 han 30 fu)
:vartype kiriage: bool
:ivar fu_for_open_pinfu: award 2 fu for open hands with no other fu sources;
when False, 1 han 20 fu hands become possible
Copy link
Collaborator

Choose a reason for hiding this comment

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

It would be a good idea to also correct the relevant part of the English Wiki.
A separate PR is fine.

:vartype fu_for_pinfu_tsumo: bool
:ivar renhou_as_yakuman: treat renhou as yakuman instead of mangan
:vartype renhou_as_yakuman: bool
:ivar has_daisharin: enable daisharin (seven consecutive pairs in one suit) as yakuman;
Copy link
Collaborator

Choose a reason for hiding this comment

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

I think it would be better to explicitly write 22334455667788 in pin

:ivar has_daisharin: enable daisharin (seven consecutive pairs in one suit) as yakuman;
automatically set to True when ``has_daisharin_other_suits`` is True
:vartype has_daisharin: bool
:ivar has_daisharin_other_suits: allow daisharin in pin and sou suits (not only man)
Copy link
Collaborator

Choose a reason for hiding this comment

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

The correct explanation is "not only pin", so please correct it.

:vartype has_daisharin: bool
:ivar has_daisharin_other_suits: allow daisharin in pin and sou suits (not only man)
:vartype has_daisharin_other_suits: bool
:ivar has_daichisei: enable daichisei (seven pairs of honor tiles) as yakuman
Copy link
Collaborator

Choose a reason for hiding this comment

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

I think it would be better to clarify that it is all honors (tsuuiisou).

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