From 05aa25573027953c3578bdc2d0c6be0e46ac1a34 Mon Sep 17 00:00:00 2001 From: John Estabrook Date: Thu, 2 Jul 2020 18:00:49 -0500 Subject: config_dict: update docstring --- python/vyos/config.py | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) (limited to 'python') diff --git a/python/vyos/config.py b/python/vyos/config.py index 1aa8082dc..780b48a7b 100644 --- a/python/vyos/config.py +++ b/python/vyos/config.py @@ -289,8 +289,13 @@ class Config(object): def get_config_dict(self, path=[], effective=False, key_mangling=None, get_first_key=False): """ - Args: path (str list): Configuration tree path, can be empty - Returns: a dict representation of the config + Args: + path (str list): Configuration tree path, can be empty + effective=False: effective or session config + key_mangling=None: mangle dict keys according to regex and replacement + get_first_key=False: if k = path[:-1], return sub-dict d[k] instead of {k: d[k]} + + Returns: a dict representation of the config under path """ config_dict = {} -- cgit v1.2.3