search

MahjongRepository / mahjong

Implementation of riichi mahjong related stuff (hand cost, shanten, agari end, etc.)
MIT License
377 stars 38 forks source link

Future 1.2.0 version #31

Closed Nihisil closed 2 years ago

Nihisil commented 3 years ago

Looking at the project architecture I'm seeing multiple places where we can improve the code structure to support future changes more easily.

Because of that, I decided to release a new version without compatibility with the old version.

Main planned features for the new version:

Enerccio commented 3 years ago

while python itself might not be supported there are other projects that use python 2 internally (such as renpy which might actually use this library for minigame for instane) or python embedded into any c application

Nihisil commented 3 years ago

You always can continue to use v1.1.11 version in that case.

Nihisil commented 3 years ago

https://www.python.org/doc/sunset-python-2/

We are volunteers who make and take care of the Python programming language. We have decided that January 1, 2020, was the day that we sunset Python 2.

It was almost one year ago. I think with time more and more old libs will migrate to Python 3.

profthecopyright commented 3 years ago

Good to know you have ukeire calculations already. Then I will just wait for you to merge it into mahjong lib (hopefully with both tile name and numbers).

Nihisil commented 3 years ago

Yep, I think I will move this code in next days.

profthecopyright commented 3 years ago

Also, since I am not fluent enough in Japanese (especially in writing), it is better to have someone proficient enough review the translations before we make a formal release.

Nihisil commented 3 years ago

Got it. Yep, I think we will find someone for texts review.

Gennadiyev commented 2 years ago

Hi! I'd like to ask whether the project is still active, to be specific, if a new release (v1.2.0) is around the corner, before I start writing a documentation for the current version~

Nihisil commented 2 years ago

@Gennadiyev Hi! Unfortunately, right now I can't spare resources to work on the project, I think I can release the current version as is, it already contains various improvements in the logic. The bad thing is that it contains a lot of changes in interfaces, which I'm afraid I can't document in release notes properly.

Will that work for you?

And if we are lucky later all planned features will be implemented.

Also, I am curious what kind of documentation are you planning to write?

profthecopyright commented 2 years ago

Good! If new docs are released I will be happy to follow-up with Chinese versions! Perhaps we can continue with the locale stuff but unfortunately I didn't have dedicated time for that lately.

Get Outlook for iOShttps://aka.ms/o0ukef

From: Aleksei Lisikhin @.> Sent: Tuesday, May 17, 2022 1:05:52 PM To: MahjongRepository/mahjong @.> Cc: Hongbo Li @.>; Comment @.> Subject: Re: [MahjongRepository/mahjong] Future 1.2.0 version (#31)

@Gennadiyevhttps://nam02.safelinks.protection.outlook.com/?url=https%3A%2F%2Fgithub.com%2FGennadiyev&data=05%7C01%7Chli126%40jhu.edu%7C3d5620325a984a0b4f5208da3827896a%7C9fa4f438b1e6473b803f86f8aedf0dec%7C0%7C0%7C637884039744773585%7CUnknown%7CTWFpbGZsb3d8eyJWIjoiMC4wLjAwMDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1haWwiLCJXVCI6Mn0%3D%7C3000%7C%7C%7C&sdata=EVDgCErBsYoCp2jA1JmTYx0dsDz61pNjuMZKDSf5MVU%3D&reserved=0 Hi! Unfortunately, right now I can't spare resources to work on the project, I think I can release the current version as is, it already contains various improvements in the logic. The bad thing is that it contains a lot of changes in interfaces, which I'm afraid I can't document in release notes properly.

Will that work for you?

And if we are lucky later all planned features will be implemented.

Also, I am curious what kind of documentation are you planning to write?

— Reply to this email directly, view it on GitHubhttps://nam02.safelinks.protection.outlook.com/?url=https%3A%2F%2Fgithub.com%2FMahjongRepository%2Fmahjong%2Fissues%2F31%23issuecomment-1129110839&data=05%7C01%7Chli126%40jhu.edu%7C3d5620325a984a0b4f5208da3827896a%7C9fa4f438b1e6473b803f86f8aedf0dec%7C0%7C0%7C637884039744773585%7CUnknown%7CTWFpbGZsb3d8eyJWIjoiMC4wLjAwMDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1haWwiLCJXVCI6Mn0%3D%7C3000%7C%7C%7C&sdata=73pCYU%2BEBgJzUaZ50jyu4DZGm93r6MrV%2F%2FtQbe1U09Q%3D&reserved=0, or unsubscribehttps://nam02.safelinks.protection.outlook.com/?url=https%3A%2F%2Fgithub.com%2Fnotifications%2Funsubscribe-auth%2FAM75K276QBRNDQMIJ6K5DR3VKPGXBANCNFSM4TIMAMRA&data=05%7C01%7Chli126%40jhu.edu%7C3d5620325a984a0b4f5208da3827896a%7C9fa4f438b1e6473b803f86f8aedf0dec%7C0%7C0%7C637884039744773585%7CUnknown%7CTWFpbGZsb3d8eyJWIjoiMC4wLjAwMDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1haWwiLCJXVCI6Mn0%3D%7C3000%7C%7C%7C&sdata=gPQxaXREXafVqfZoDn3Cc1bIp41am5ZqnXjMdQFwVbM%3D&reserved=0. You are receiving this because you commented.Message ID: @.***>

Gennadiyev commented 2 years ago

OK, I'll first try to upgrade to the latest release and try to write some general documentations as I use the functionalities.

I'm currently using the following functions from v1.11, so expect documentation for these functions:

Nihisil commented 2 years ago

1.2.0 was released: https://pypi.org/project/mahjong/1.2.0/

It contains many bugfixes, library should handle all hands correctly now, please check release notes: https://github.com/MahjongRepository/mahjong/releases/tag/v1.2.0

Unfortunately, this release doesn't contain all the planned features, and in the next months, I most likely will not be able to work on them.

But I always welcome new PRs from the community, both with changes in code and documentation improvements.