Conversation
| "FBT001", # boolean-type-hint-positional-argument | ||
| "FBT002", # boolean-default-value-positional-argument | ||
| "FBT003", # boolean-positional-value-in-call | ||
| "D100", # missing-docstring-in-public-module |
There was a problem hiding this comment.
I think forcing module-level docstrings is a bit overkill for us. Our modules are relatively small and mostly single-purpose. Having docstrings for classes and public methods should be enough
There was a problem hiding this comment.
I generally agree, but I think the "34 tiles format" and "136 tiles format" should be explained in a module-level docstring somewhere. I think mahjong/__init__.py would be a good place to do this. What do you think?
Example:
riichienv-core (https://crates.io/crates/riichienv-core) README
Tile representation
- 136-format: Each of 34 tile types x 4 copies (indices 0-135), used for actual game state
- 34-format: Normalized tile type indices (0-33), used for calculations
- MPSZ notation:
1m-9m(man),1p-9p(pin),1s-9s(sou),1z-7z(honors)- Red fives are represented at indices 16, 52, 88 in 136-format
xiangting-py README
There was a problem hiding this comment.
Yep, we can write module comments where it is suited, no problem here.
I just don't want to have it forced for every module in the project through linter.
| "FBT001", # boolean-type-hint-positional-argument | ||
| "FBT002", # boolean-default-value-positional-argument | ||
| "FBT003", # boolean-positional-value-in-call | ||
| "D100", # missing-docstring-in-public-module |
There was a problem hiding this comment.
I generally agree, but I think the "34 tiles format" and "136 tiles format" should be explained in a module-level docstring somewhere. I think mahjong/__init__.py would be a good place to do this. What do you think?
Example:
riichienv-core (https://crates.io/crates/riichienv-core) README
Tile representation
- 136-format: Each of 34 tile types x 4 copies (indices 0-135), used for actual game state
- 34-format: Normalized tile type indices (0-33), used for calculations
- MPSZ notation:
1m-9m(man),1p-9p(pin),1s-9s(sou),1z-7z(honors)- Red fives are represented at indices 16, 52, 88 in 136-format
xiangting-py README
2 participants
#121