From f17c72ee4c959b1cfb1b3f260ade22fc5c6c5970 Mon Sep 17 00:00:00 2001 From: Daniel Watkins Date: Fri, 16 Aug 2019 15:51:49 +0000 Subject: cloudinit/distros/parsers/sys_conf: add docstring to SysConf --- cloudinit/distros/parsers/sys_conf.py | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/cloudinit/distros/parsers/sys_conf.py b/cloudinit/distros/parsers/sys_conf.py index c27b5d5d..44df17de 100644 --- a/cloudinit/distros/parsers/sys_conf.py +++ b/cloudinit/distros/parsers/sys_conf.py @@ -43,6 +43,13 @@ def _contains_shell_variable(text): class SysConf(configobj.ConfigObj): + """A configobj.ConfigObj subclass specialised for sysconfig files. + + :param contents: + The sysconfig file to parse, in a format accepted by + ``configobj.ConfigObj.__init__`` (i.e. "a filename, file like object, + or list of lines"). + """ def __init__(self, contents): configobj.ConfigObj.__init__(self, contents, interpolation=False, -- cgit v1.2.3