aboutsummaryrefslogtreecommitdiffstats
path: root/README
diff options
context:
space:
mode:
authorMattias Andrée <maandree@kth.se>2016-11-26 02:07:46 +0100
committerMattias Andrée <maandree@kth.se>2016-11-26 02:07:46 +0100
commit761bb3b30b5eb8c923f909effdc0c5ea53b16ac5 (patch)
treebb3a7291a8c239d4d68b93ddcb48feb095d9e10d /README
parentImprove cmdline parsing (diff)
downloaddlu-761bb3b30b5eb8c923f909effdc0c5ea53b16ac5.tar.gz
dlu-761bb3b30b5eb8c923f909effdc0c5ea53b16ac5.tar.bz2
dlu-761bb3b30b5eb8c923f909effdc0c5ea53b16ac5.tar.xz
small improvements
Signed-off-by: Mattias Andrée <maandree@kth.se>
Diffstat (limited to 'README')
-rw-r--r--README6
1 files changed, 4 insertions, 2 deletions
diff --git a/README b/README
index 5046a99..934b424 100644
--- a/README
+++ b/README
@@ -13,9 +13,11 @@ DESCRIPTION
list_dictionaries()
Returns a list of all dictionaries.
- load_dictionary(dictionary : str)
+ load_dictionary(dictionary : str) -> bool
Sets the fuction get() or a variable that get() reads
- to identify which dictionary has been selected.
+ to identify which dictionary has been selected. The
+ function shall return True if the dictionary exists,
+ and False otherwise.
open_dictionary(file : str, page : int)
Opens the specified page in the specified file.