aboutsummaryrefslogtreecommitdiffstats
path: root/README
diff options
context:
space:
mode:
authorMattias Andrée <m@maandree.se>2026-02-25 18:18:06 +0100
committerMattias Andrée <m@maandree.se>2026-02-25 18:18:06 +0100
commit7418e41181a9fb829365b4050b51575e1f773881 (patch)
treeea0dd5f7e88de913b6f163800a4790f2a6ff8d60 /README
parentm fixes (diff)
downloaddlu-7418e41181a9fb829365b4050b51575e1f773881.tar.gz
dlu-7418e41181a9fb829365b4050b51575e1f773881.tar.bz2
dlu-7418e41181a9fb829365b4050b51575e1f773881.tar.xz
m + add "before" function for collationHEAD1.1master
Signed-off-by: Mattias Andrée <m@maandree.se>
Diffstat (limited to '')
-rw-r--r--README12
1 files changed, 10 insertions, 2 deletions
diff --git a/README b/README
index a6a989c..d4bf65d 100644
--- a/README
+++ b/README
@@ -30,10 +30,18 @@ DESCRIPTION
Modifies and returns a word so that it can be used
to compare against known words in the dictionary.
- The default implementation of this function converts the
- word to lower case using Python's string class's
+ The default implementation of this function converts
+ the word to lower case using Python's string class's
lower() function.
+ before(word1 : str, word2 : str) -> bool
+ Collation function that checks that word1 comes before
+ word2 in the dictionary (if so, it returns True,
+ otherwise it returns False).
+
+ The default implementation of this function compares
+ in C locale.
+
get() -> tuple
Returns a 3-tuple containing, in order: the filename
of the scanned dictionary, a list of the last word on