From 9258cbf76d7359f4bb63ba5857dc05bfc091d5a8 Mon Sep 17 00:00:00 2001 From: InsanePrawn Date: Sun, 24 Oct 2021 07:01:14 +0200 Subject: [PATCH] config.py: docstring fixes --- config.py | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/config.py b/config.py index 8d0fc40..abba559 100644 --- a/config.py +++ b/config.py @@ -499,7 +499,10 @@ def cmd_config_init(sections: list[str] = CONFIG_SECTIONS, non_interactive: bool @noop_flag @click.argument('key_vals', nargs=-1) def cmd_config_set(key_vals: list[str], non_interactive: bool = False, noop: bool = False): - """set config entries as `key=value` pairs, like `set build.clean_mode=false`""" + """ + Set config entries. Pass entries as `key=value` pairs, with keys as dot-separated identifiers, + like `build.clean_mode=false` or alternatively just keys to get prompted if run interactively. + """ config.enforce_config_loaded() config_copy = deepcopy(config.file) for pair in key_vals: @@ -532,7 +535,8 @@ def cmd_config_set(key_vals: list[str], non_interactive: bool = False, noop: boo @cmd_config.command(name='get') @click.argument('keys', nargs=-1) def cmd_config_get(keys: list[str]): - """get config entries, passed as `key=value` pairs, like `build.clean_mode`""" + """Get config entries. + Get entries for keys passed as dot-separated identifiers, like `build.clean_mode`""" if len(keys) == 1: print(config_dot_name_get(keys[0], config.file)) return