Update README.md

This commit is contained in:
Alexis Gavoty 2012-10-14 23:08:23 +03:00
parent a9949c044a
commit fe6448e2a9

View file

@ -76,18 +76,18 @@ Contribute
---------- ----------
Only few functions are implemented yet. If you want to contribute, just pick one action above (i.e. 'yunohost app addaccess') and make the function (here 'app_addaccess()') into the right file (here 'yunohost_app.py'). Only few functions are implemented yet. If you want to contribute, just pick one action above (i.e. `yunohost app addaccess`) and make the function (here `app_addaccess()`) into the right file (here `yunohost_app.py`).
If you need LDAP connections or openned configuration files, take a look at the connection documentation in the 'yunohost.py' file. If you need LDAP connections or openned configuration files, take a look at the connection documentation in the `yunohost.py` file.
Dev self-notes Dev self-notes
-------------- --------------
* A big dictionary of categories/actions/arguments is translated to parsers and subparsers with argument handling (argparse python library) * A big dictionary of categories/actions/arguments is translated to parsers and subparsers with argument handling (argparse python library)
* One single action function is called after the parsing, named like 'category_action()' * One single action function is called after the parsing, named like `category_action()`
* Connection to LDAP and/or config file openning is made before the action function * Connection to LDAP and/or config file openning is made before the action function
* Parsed arguments and connection dictionary are the only parameters passed to the action function * Parsed arguments and connection dictionary are the only parameters passed to the action function :
category_action(args, connections) `category_action(args, connections)`
* 'connections' is optionnal * 'connections' is optionnal
* Connections are closed just before the sys.exit calling * Connections are closed just before the sys.exit calling