summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorWolfgang Rohdewald <wolfgang@rohdewald.de>2016-08-25 06:29:03 (GMT)
committerWolfgang Rohdewald <wolfgang@rohdewald.de>2016-08-25 06:43:14 (GMT)
commit6fd1260c8a2dba615e9e31a8a7acc0305c6c7058 (patch)
tree82acfdb881bb006d9ddb66cf830b4f82a619aea6
parent8a5e679af85ac07d89054656821c5744efb1829b (diff)
rulecode: docstrings
-rw-r--r--src/rulecode.py13
1 files changed, 12 insertions, 1 deletions
diff --git a/src/rulecode.py b/src/rulecode.py
index 7e1404d..b8e4c22 100644
--- a/src/rulecode.py
+++ b/src/rulecode.py
@@ -42,10 +42,17 @@ class RuleCode(object):
All methods in RuleCode classes will automatically be converted
into staticmethods or classmethods if the 1st arg is named 'cls'.
+
+ winningTileCandidates(cls, hand):
+ All rules for going MahJongg must have such a method.
+ This is used to find all winning hands which only need
+ one tile: The calling hands (after calling)
+
"""
cache = ()
+
# pylint: disable=missing-docstring
# the class and method names are mostly self explaining, we do not
# need docstringss
@@ -1012,7 +1019,11 @@ class EastWonNineTimesInARow(RuleCode):
class GatesOfHeaven(StandardMahJongg):
- """as used for Classical Chinese BMJA"""
+ """as used for Classical Chinese BMJA.
+
+ I believe that when they say a run of 2..8, they must
+ all be concealed
+ """
cache = ()