From 16d2c56dd205727ff954690c437f93a96a63e462 Mon Sep 17 00:00:00 2001 From: Santo Cariotti Date: Sat, 22 Jul 2017 08:17:21 +0200 Subject: added doc --- lib/listcommands.py | 13 ++++++++----- 1 file changed, 8 insertions(+), 5 deletions(-) diff --git a/lib/listcommands.py b/lib/listcommands.py index a47d8f5..d2f83a0 100644 --- a/lib/listcommands.py +++ b/lib/listcommands.py @@ -7,11 +7,14 @@ class ListCommands(object): """ info = { - 'info' : 'this is stout', - 'set' : ['set a value', 3], - 'get' : ['return a value', 3], - 'add' : ['new TODO',], - 'del' : ['del TODO', 2] + 'info' : '''Stout è distribuito sotto licenza MIT e pertanto è possibile farne il fork, modificarlo e distribuirlo nuovamente. +La lista dei comandi è disponibile su https://github.com/dcariotti/Stout. +Scrivere info [cmd] per avere più informazioni su un comando.''', + 'set' : ['''Inserire un valore; accetta solo 1 parametro (user) e viene utilizzato nel modo seguente: set user NAME''', 3], + 'get' : ['''Ritorna un valore e accetta i parametri todo (ritorna la lista dei todo) e ctodo (ritorna il numero dei todo). +Se utilizzato con il "flag" i, si possono visualizzare le info: get i host, get i port, get i unix_socket_path, get i db, get i user''', 3], + 'add' : ['Inserisce un nuovo todo: ogni carattere dopo add sarà considerato tale',], + 'del' : ['Elimina un todo in base alla sua chiave di valore; per vederle tutte, digitare get todo', 2] } commands = { -- cgit v1.2.3-18-g5258