From 0ad3dd5816440a3d9913c2e5282b0907f072fdbe Mon Sep 17 00:00:00 2001 From: Theophile GENTILHOMME <tgentilhomme@jurasix08.idiap.ch> Date: Thu, 5 Jul 2018 11:22:21 +0200 Subject: [PATCH] Add function doc --- bob/extension/config.py | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/bob/extension/config.py b/bob/extension/config.py index aa85125..cd0d06b 100644 --- a/bob/extension/config.py +++ b/bob/extension/config.py @@ -216,6 +216,16 @@ def mod_to_context(mod): def dump_config(params, ctx): + """ Generate configuration file from parameters and context + + Parameters + ---------- + params : :any:`list` + List of parameters. For example, params attributes of click.Option. + ctx : dict + Click context dictionary. + + """ config_file = open(ctx.params.get('dump_config'), 'w') logger.debug("Generating configuration file `%s'...", config_file) config_file.write('## Configuration file automatically generated at %s ' -- GitLab