config_dict: update docstring

1 files changed, 7 insertions, 2 deletions

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 = {}