Skip to content

Commit 107f47c

Browse files
committed
chore: prepare release 2.0.0
1 parent 7c1ba9c commit 107f47c

4 files changed

Lines changed: 146 additions & 5 deletions

File tree

.github/wiki/Home.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Mahjong Library Documentation
22

3-
## v2 version (in development)
3+
## v2 version
44
- [[v2-English]]
55
- [[v2-Chinese]]
66
- [[v2-Japanese]]

.github/wiki/_Sidebar.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Documentation
22

3-
**v2** (in development)
3+
**v2**
44
- [[v2-English]]
55
- [[v2-Chinese]]
66
- [[v2-Japanese]]

CHANGELOG.md

Lines changed: 143 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
Releases History
22
================
33

4-
2.0.0 (TBD)
4+
2.0.0
55
-------------------
66

77
## New features
@@ -118,7 +118,148 @@ The following methods are now available as static methods:
118118
- Hands without yaku no longer count dora. `HandResponse` now returns only `error` with all other fields as `None`, instead of returning `han`, `fu`, and dora yaku alongside the error.
119119

120120
## What's Changed
121-
- Placeholder. It would be filled on release automatically
121+
* refactor: Simplify to_136_array implementation by @Apricot-S in https://github.com/MahjongRepository/mahjong/pull/93
122+
* feat: Change instance methods to static methods by @Apricot-S in https://github.com/MahjongRepository/mahjong/pull/92
123+
* feat: Rewrite `HandDivider.divide_hand()` with a backtracking-based algorithm and caching improvements by @Apricot-S in https://github.com/MahjongRepository/mahjong/pull/94
124+
* feat: Remove deprecated `Meld.CHANKAN` property by @Apricot-S in https://github.com/MahjongRepository/mahjong/pull/95
125+
* feat: Remove deprecated `Yaku.english` and `Yaku.japanese` properties by @Apricot-S in https://github.com/MahjongRepository/mahjong/pull/96
126+
* refactor: Eliminate an unnecessary generator expression by @Apricot-S in https://github.com/MahjongRepository/mahjong/pull/97
127+
* refactor: Use list comprehension in `_decompose_chiitoitsu` by @Apricot-S in https://github.com/MahjongRepository/mahjong/pull/98
128+
* fix: Fix type hint for `fu_details` parameter of `HandResponse.__init__()` by @Apricot-S in https://github.com/MahjongRepository/mahjong/pull/100
129+
* feat: Migrate class variables to type annotations by @Apricot-S in https://github.com/MahjongRepository/mahjong/pull/99
130+
* refactor: Simplify `TilesConverter.to_one_line_string()` implementation by @Apricot-S in https://github.com/MahjongRepository/mahjong/pull/101
131+
* fix: Fix type hint for `valued_tiles` parameter of `FuCalculator.calculate_fu()` by @Apricot-S in https://github.com/MahjongRepository/mahjong/pull/102
132+
* refactor: Simplify `is_dora_indicator_for_terminal()` implementation by @Apricot-S in https://github.com/MahjongRepository/mahjong/pull/106
133+
* refactor: Simplify `simplify()` implementation by @Apricot-S in https://github.com/MahjongRepository/mahjong/pull/107
134+
* test: Split agari multi‑assert tests into parameterized tests by @Apricot-S in https://github.com/MahjongRepository/mahjong/pull/123
135+
* test: Split shanten multi‑assert tests into parameterized tests by @Apricot-S in https://github.com/MahjongRepository/mahjong/pull/124
136+
* test: Split utils multi‑assert tests into parameterized tests by @Apricot-S in https://github.com/MahjongRepository/mahjong/pull/126
137+
* feat: Add `Shanten.TENPAI_STATE` by @Apricot-S in https://github.com/MahjongRepository/mahjong/pull/127
138+
* refactor!: Improve performance across the project by @Nihisil in https://github.com/MahjongRepository/mahjong/pull/128
139+
* refactor!: drop support for Python 3.9 by @Nihisil in https://github.com/MahjongRepository/mahjong/pull/131
140+
* chore: Update Ruff Configuration to `select = ["ALL"]` by @Apricot-S in https://github.com/MahjongRepository/mahjong/pull/132
141+
* refactor: Fix lint print-empty-string (FURB105) by @Apricot-S in https://github.com/MahjongRepository/mahjong/pull/133
142+
* docs: Update CHANGELOG.md by @Apricot-S in https://github.com/MahjongRepository/mahjong/pull/130
143+
* chore: improve tests coverage by @Nihisil in https://github.com/MahjongRepository/mahjong/pull/134
144+
* fix: Check that no melds are present when decomposing chiitoitsu by @Apricot-S in https://github.com/MahjongRepository/mahjong/pull/135
145+
* refactor: Use match statement in _decompose_honors_hand() by @Apricot-S in https://github.com/MahjongRepository/mahjong/pull/136
146+
* refactor: Streamline the determination of ChuurenPoutou by @Apricot-S in https://github.com/MahjongRepository/mahjong/pull/138
147+
* feat: Add DRAGONS by @Apricot-S in https://github.com/MahjongRepository/mahjong/pull/139
148+
* refactor: Fix lint yoda-conditions (SIM300) by @Apricot-S in https://github.com/MahjongRepository/mahjong/pull/143
149+
* refactor! redo yaku_id system by @Nihisil in https://github.com/MahjongRepository/mahjong/pull/137
150+
* refactor! refactor yaku class further by @Nihisil in https://github.com/MahjongRepository/mahjong/pull/144
151+
* refactor: Fix lint implicit-return-value (RET502) by @Apricot-S in https://github.com/MahjongRepository/mahjong/pull/145
152+
* refactor: Fix lint utf8-encoding-declaration (UP009) by @Apricot-S in https://github.com/MahjongRepository/mahjong/pull/146
153+
* refactor: Fix lint repeated-equality-comparison (PLR1714) by @Apricot-S in https://github.com/MahjongRepository/mahjong/pull/148
154+
* feat: add ura dora yaku by @Nihisil in https://github.com/MahjongRepository/mahjong/pull/147
155+
* refactor: Fix lint reimplemented-builtin (SIM110) by @Apricot-S in https://github.com/MahjongRepository/mahjong/pull/149
156+
* refactor: Fix lint len-test (PLC1802) by @Apricot-S in https://github.com/MahjongRepository/mahjong/pull/150
157+
* refactor: Fix lint unnecessary-range-start (PIE808) by @Apricot-S in https://github.com/MahjongRepository/mahjong/pull/151
158+
* refactor: Fix lint parenthesize-chained-operators (RUF021) by @Apricot-S in https://github.com/MahjongRepository/mahjong/pull/153
159+
* feat: improve yakuhai yaku by @Nihisil in https://github.com/MahjongRepository/mahjong/pull/152
160+
* refactor: Fix lint collection-literal-concatenation (RUF005) by @Apricot-S in https://github.com/MahjongRepository/mahjong/pull/155
161+
* chore: Update actions/checkout by @Apricot-S in https://github.com/MahjongRepository/mahjong/pull/156
162+
* refactor!: improve performance of fu calculations by @Nihisil in https://github.com/MahjongRepository/mahjong/pull/157
163+
* chore: Add maintainers by @Apricot-S in https://github.com/MahjongRepository/mahjong/pull/154
164+
* chore: Install only the packages required by CI by @Apricot-S in https://github.com/MahjongRepository/mahjong/pull/158
165+
* refactor: Fix lint invalid-assert-message-literal-argument (RUF040) by @Apricot-S in https://github.com/MahjongRepository/mahjong/pull/159
166+
* refactor: Fix lint unnecessary-iterable-allocation-for-first-element (RUF015) by @Apricot-S in https://github.com/MahjongRepository/mahjong/pull/160
167+
* refactor: Fix lint unnecessary-assign (RET504) by @Apricot-S in https://github.com/MahjongRepository/mahjong/pull/161
168+
* refactor: Fix lint superfluous-else-return (RET505) by @Apricot-S in https://github.com/MahjongRepository/mahjong/pull/162
169+
* fix: Fix reutrn value of KokushiMusou.is_condition_met() by @Apricot-S in https://github.com/MahjongRepository/mahjong/pull/163
170+
* refactor: Fix lint implicit-return (RET503) by @Apricot-S in https://github.com/MahjongRepository/mahjong/pull/164
171+
* refactor: Fix lint unused-unpacked-variable (RUF059) by @Apricot-S in https://github.com/MahjongRepository/mahjong/pull/165
172+
* refactor: Fix lint manual-list-comprehension (PERF401) by @Apricot-S in https://github.com/MahjongRepository/mahjong/pull/166
173+
* refactor: Fix lint if-stmt-min-max (PLR1730) by @Apricot-S in https://github.com/MahjongRepository/mahjong/pull/167
174+
* refactor: Fix lint f-string (UP032) by @Apricot-S in https://github.com/MahjongRepository/mahjong/pull/168
175+
* refactor: improve dora calculations performance by @Nihisil in https://github.com/MahjongRepository/mahjong/pull/169
176+
* refactor: improve Agari.is_agari performace by @Nihisil in https://github.com/MahjongRepository/mahjong/pull/170
177+
* refactor: Fix lint collapsible-else-if (PLR5501) by @Apricot-S in https://github.com/MahjongRepository/mahjong/pull/172
178+
* refactor: Fix lint collapsible-if (SIM102) by @Apricot-S in https://github.com/MahjongRepository/mahjong/pull/173
179+
* chore: publish wiki from source code by @Nihisil in https://github.com/MahjongRepository/mahjong/pull/174
180+
* refactor: Fix lint if-else-block-instead-of-if-exp (SIM108) by @Apricot-S in https://github.com/MahjongRepository/mahjong/pull/175
181+
* refactor: Fix lint eq-without-hash (PLW1641) by @Apricot-S in https://github.com/MahjongRepository/mahjong/pull/176
182+
* refactor: Fix lint blanket-type-ignore (PGH003) by @Apricot-S in https://github.com/MahjongRepository/mahjong/pull/177
183+
* refactor: Fix lint unused-static-method-argument (ARG004) by @Apricot-S in https://github.com/MahjongRepository/mahjong/pull/178
184+
* chore: Ignore lint unused-method-argument (ARG002) by @Apricot-S in https://github.com/MahjongRepository/mahjong/pull/180
185+
* refactor: Fix lint redefined-loop-name (PLW2901) by @Apricot-S in https://github.com/MahjongRepository/mahjong/pull/181
186+
* chore: Update Ruff by @Apricot-S in https://github.com/MahjongRepository/mahjong/pull/182
187+
* style: Fix lint missing-trailing-comma (COM812) by @Apricot-S in https://github.com/MahjongRepository/mahjong/pull/183
188+
* feat!: Replace assert with `ValueError` for tile count validation in `Shanten.calculate_shanten_for_regular_hand()` by @Apricot-S in https://github.com/MahjongRepository/mahjong/pull/184
189+
* chore: add wiki v2 pages by @Nihisil in https://github.com/MahjongRepository/mahjong/pull/179
190+
* refactor: Simplify `TilesConverter.string_to_136_array()` implementation by @Apricot-S in https://github.com/MahjongRepository/mahjong/pull/186
191+
* refactor: improve hand divider performance a bit by @Nihisil in https://github.com/MahjongRepository/mahjong/pull/185
192+
* docs: Add Japanese wiki by @Apricot-S in https://github.com/MahjongRepository/mahjong/pull/188
193+
* refactor: optimize performance for hand calculations by @Nihisil in https://github.com/MahjongRepository/mahjong/pull/189
194+
* chore: Add wiki URL to `[project.urls]` by @Apricot-S in https://github.com/MahjongRepository/mahjong/pull/191
195+
* fix: Add validation for hand decomposition by @Apricot-S in https://github.com/MahjongRepository/mahjong/pull/190
196+
* chore: Ignore lint missing-trailing-comma (COM812) by @Apricot-S in https://github.com/MahjongRepository/mahjong/pull/194
197+
* refactor: improve performance for hand calculations further by @Nihisil in https://github.com/MahjongRepository/mahjong/pull/192
198+
* docs: Add trailing commas to code examples on the wiki by @Apricot-S in https://github.com/MahjongRepository/mahjong/pull/196
199+
* docs: Split the examples into separate files by @Apricot-S in https://github.com/MahjongRepository/mahjong/pull/197
200+
* test: add parametrize for some pytest tests by @Nihisil in https://github.com/MahjongRepository/mahjong/pull/193
201+
* refactor: rename aka doras const by @Nihisil in https://github.com/MahjongRepository/mahjong/pull/201
202+
* refactor: change meld tiles from list to tuple by @Nihisil in https://github.com/MahjongRepository/mahjong/pull/200
203+
* fix: Fix type error of Meld.tiles by @Apricot-S in https://github.com/MahjongRepository/mahjong/pull/202
204+
* refactor: replace dict responses with typed dicts by @Nihisil in https://github.com/MahjongRepository/mahjong/pull/203
205+
* fix: Allow round and seat wind parameters to be optional in condition checks by @Apricot-S in https://github.com/MahjongRepository/mahjong/pull/204
206+
* bug: hands without yaku but with dora should be rejected by @Nihisil in https://github.com/MahjongRepository/mahjong/pull/206
207+
* docs: Fix description for kazoe_limit parameter in Wiki by @Apricot-S in https://github.com/MahjongRepository/mahjong/pull/208
208+
* chore: Add ty to dev dependencies by @Apricot-S in https://github.com/MahjongRepository/mahjong/pull/209
209+
* chore: Limit the type checking to only the library by @Apricot-S in https://github.com/MahjongRepository/mahjong/pull/211
210+
* docs: Align the explanation of daichisei in the Chinese version of the Wiki with the English and Japanese versions by @Apricot-S in https://github.com/MahjongRepository/mahjong/pull/212
211+
* chore: Add type checking to make commands and CI by @Apricot-S in https://github.com/MahjongRepository/mahjong/pull/213
212+
* chore: Add format check to lint command by @Apricot-S in https://github.com/MahjongRepository/mahjong/pull/214
213+
* docs: Translate `Output` in Japanese Wiki by @Apricot-S in https://github.com/MahjongRepository/mahjong/pull/215
214+
* docs: add v2 version link for v1 pages by @Nihisil in https://github.com/MahjongRepository/mahjong/pull/216
215+
* docs: fix license copyright by @Nihisil in https://github.com/MahjongRepository/mahjong/pull/218
216+
* chore: add codeowners file by @Nihisil in https://github.com/MahjongRepository/mahjong/pull/217
217+
* chore: Add ruff settings for docstring by @Apricot-S in https://github.com/MahjongRepository/mahjong/pull/220
218+
* chore: Update MANIFEST.in by @Apricot-S in https://github.com/MahjongRepository/mahjong/pull/221
219+
* docs: add agari section to wiki, extend shanten section by @Nihisil in https://github.com/MahjongRepository/mahjong/pull/219
220+
* docs: Update examples by @Apricot-S in https://github.com/MahjongRepository/mahjong/pull/222
221+
* docs: add validation results by @Nihisil in https://github.com/MahjongRepository/mahjong/pull/223
222+
* docs: add doc for agari class by @Nihisil in https://github.com/MahjongRepository/mahjong/pull/224
223+
* docs: add shanten doc by @Nihisil in https://github.com/MahjongRepository/mahjong/pull/225
224+
* docs: Introduce Sphinx by @Apricot-S in https://github.com/MahjongRepository/mahjong/pull/226
225+
* feat: Add each yaku to `__all__` in `__init__.py` by @Apricot-S in https://github.com/MahjongRepository/mahjong/pull/227
226+
* docs: Add API documentation by @Apricot-S in https://github.com/MahjongRepository/mahjong/pull/228
227+
* docs: add meld doc by @Nihisil in https://github.com/MahjongRepository/mahjong/pull/229
228+
* docs: Add the description for tile representations to the pacakege docstring by @Apricot-S in https://github.com/MahjongRepository/mahjong/pull/230
229+
* chore: Improve sphinx options by @Apricot-S in https://github.com/MahjongRepository/mahjong/pull/231
230+
* docs: Fix the package docstring by @Apricot-S in https://github.com/MahjongRepository/mahjong/pull/232
231+
* docs: add doc for constants by @Nihisil in https://github.com/MahjongRepository/mahjong/pull/233
232+
* docs: Update documentation links in README by @Apricot-S in https://github.com/MahjongRepository/mahjong/pull/234
233+
* docs: add tiles documentation by @Nihisil in https://github.com/MahjongRepository/mahjong/pull/235
234+
* docs: Add a license section to README by @Apricot-S in https://github.com/MahjongRepository/mahjong/pull/237
235+
* docs: add utils documentation by @Nihisil in https://github.com/MahjongRepository/mahjong/pull/236
236+
* docs: Unify tile representation by @Apricot-S in https://github.com/MahjongRepository/mahjong/pull/238
237+
* docs: Match the nuances of the Chinese and Japanese wikis to the English version by @Apricot-S in https://github.com/MahjongRepository/mahjong/pull/240
238+
* docs: add fu doc by @Nihisil in https://github.com/MahjongRepository/mahjong/pull/239
239+
* bug: stabilize shanten input validation by @Nihisil in https://github.com/MahjongRepository/mahjong/pull/242
240+
* docs: add hand divider documentation by @Nihisil in https://github.com/MahjongRepository/mahjong/pull/243
241+
* refactor: Avoid creating instances of `Yaku` for `yaku_id` references by @Apricot-S in https://github.com/MahjongRepository/mahjong/pull/247
242+
* docs: add hand config documentation by @Nihisil in https://github.com/MahjongRepository/mahjong/pull/244
243+
* docs: add hand response documentation by @Nihisil in https://github.com/MahjongRepository/mahjong/pull/248
244+
* docs: add scores documentation by @Nihisil in https://github.com/MahjongRepository/mahjong/pull/250
245+
* docs: add hand documentation by @Nihisil in https://github.com/MahjongRepository/mahjong/pull/249
246+
* chore: Tweak pyproject.toml settings by @Apricot-S in https://github.com/MahjongRepository/mahjong/pull/251
247+
* docs: add init modules documentation by @Nihisil in https://github.com/MahjongRepository/mahjong/pull/254
248+
* docs: add yaku config documentation by @Nihisil in https://github.com/MahjongRepository/mahjong/pull/252
249+
* docs: add yaku abstract class documentation by @Nihisil in https://github.com/MahjongRepository/mahjong/pull/253
250+
* chore: Update actions/deploy-pages by @Apricot-S in https://github.com/MahjongRepository/mahjong/pull/255
251+
* chore: Specify ruff ignore for each individual yaku by @Apricot-S in https://github.com/MahjongRepository/mahjong/pull/256
252+
* docs: Add the hand_calculating module docstring by @Apricot-S in https://github.com/MahjongRepository/mahjong/pull/257
253+
* docs: Simplify docstring by inlining mpsz-notation example by @Apricot-S in https://github.com/MahjongRepository/mahjong/pull/258
254+
* docs: add yaku and yakuman documentation by @Nihisil in https://github.com/MahjongRepository/mahjong/pull/259
255+
* docs: Normalize terminology in Japanese wiki by replacing "断幺九" with the standard mahjong notation "断么九" by @Apricot-S in https://github.com/MahjongRepository/mahjong/pull/260
256+
* docs: Correct "pon/kan" to "pon or kan" by @Apricot-S in https://github.com/MahjongRepository/mahjong/pull/261
257+
* docs: add missed doc strings by @Nihisil in https://github.com/MahjongRepository/mahjong/pull/262
258+
* docs: Clarify shanten calculation details and target hand structure in docstring by @Apricot-S in https://github.com/MahjongRepository/mahjong/pull/263
259+
* docs: add missed doc strings by @Nihisil in https://github.com/MahjongRepository/mahjong/pull/264
260+
* docs: Improve README by @Apricot-S in https://github.com/MahjongRepository/mahjong/pull/265
261+
262+
**Full Changelog**: https://github.com/MahjongRepository/mahjong/compare/v1.4.0...v2.0.0
122263

123264
1.4.0 (Oct 20, 2025)
124265
-------------------

pyproject.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
[project]
22
name = "mahjong"
3-
version = "2.0.0.dev2"
3+
version = "2.0.0"
44
description = "Mahjong hands calculation"
55
authors = [
66
{ name = "Alexey Lisikhin", email = "alexey@nihisil.com" },

0 commit comments

Comments
 (0)