From 60caf1266c3f613c6e50394bb198d4216ce46bb2 Mon Sep 17 00:00:00 2001
From: Aleksei Lisikhin <alexey@nihisil.com>
Date: Mon, 30 Mar 2026 21:15:41 +0700
Subject: [PATCH] docs: add missed doc strings

---
 mahjong/hand_calculating/yaku.py                     | 12 ++++++++++++
 mahjong/hand_calculating/yaku_list/__init__.py       |  2 ++
 .../hand_calculating/yaku_list/yakuman/__init__.py   |  2 ++
 3 files changed, 16 insertions(+)

diff --git a/mahjong/hand_calculating/yaku.py b/mahjong/hand_calculating/yaku.py
index 829b6c3..6d54d7d 100644
--- a/mahjong/hand_calculating/yaku.py
+++ b/mahjong/hand_calculating/yaku.py
@@ -1,3 +1,15 @@
+"""
+Abstract base for yaku pattern detection.
+
+Defines the :class:`Yaku` base class that every concrete yaku inherits.
+Each subclass represents one scoring pattern (e.g., tanyao, riichi, kokushi musou)
+and implements :meth:`~Yaku.is_condition_met` to test whether the pattern is
+present in a given hand decomposition.
+
+Concrete yaku are located in the :mod:`~mahjong.hand_calculating.yaku_list`
+and :mod:`~mahjong.hand_calculating.yaku_list.yakuman` packages.
+"""
+
 from abc import ABC, abstractmethod
 from collections.abc import Collection, Sequence
 
diff --git a/mahjong/hand_calculating/yaku_list/__init__.py b/mahjong/hand_calculating/yaku_list/__init__.py
index 17e5628..aa7033e 100644
--- a/mahjong/hand_calculating/yaku_list/__init__.py
+++ b/mahjong/hand_calculating/yaku_list/__init__.py
@@ -4,6 +4,8 @@
 Each class implements :meth:`~mahjong.hand_calculating.yaku.Yaku.is_condition_met`
 to test whether the pattern is present in a given hand decomposition.
 
+For yakuman-level patterns see :mod:`~mahjong.hand_calculating.yaku_list.yakuman`.
+
 All classes are re-exported here for convenient access via
 ``from mahjong.hand_calculating.yaku_list import <ClassName>``.
 """
diff --git a/mahjong/hand_calculating/yaku_list/yakuman/__init__.py b/mahjong/hand_calculating/yaku_list/yakuman/__init__.py
index 023af43..35205f4 100644
--- a/mahjong/hand_calculating/yaku_list/yakuman/__init__.py
+++ b/mahjong/hand_calculating/yaku_list/yakuman/__init__.py
@@ -1,6 +1,8 @@
 """
 Concrete :class:`~mahjong.hand_calculating.yaku.Yaku` subclasses for yakuman-level patterns.
 
+Yakuman are the highest-value hands in mahjong.
+
 All classes are re-exported here for convenient access via
 ``from mahjong.hand_calculating.yaku_list.yakuman import <ClassName>``.
 """