summaryrefslogtreecommitdiff
path: root/cloudinit/distros
diff options
context:
space:
mode:
authorDaniel Watkins <daniel@daniel-watkins.co.uk>2019-08-16 15:51:49 +0000
committerServer Team CI Bot <josh.powers+server-team-bot@canonical.com>2019-08-16 15:51:49 +0000
commitf17c72ee4c959b1cfb1b3f260ade22fc5c6c5970 (patch)
treeff47ec8bb340f2f0f05b7d60236b3ccc3e6f0060 /cloudinit/distros
parentbcc2c43e2a5e7a965da4020da8db028b409ee224 (diff)
downloadcloud-init-git-f17c72ee4c959b1cfb1b3f260ade22fc5c6c5970.tar.gz
cloudinit/distros/parsers/sys_conf: add docstring to SysConf
Diffstat (limited to 'cloudinit/distros')
-rw-r--r--cloudinit/distros/parsers/sys_conf.py7
1 files changed, 7 insertions, 0 deletions
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,