This is an automated email from the git hooks/post-receive script. x2go pushed a commit to branch master in repository x2gobroker. commit 3a3088cff7c3c4b119a5c69e6bd7eed64104dc1b Author: Mike Gabriel <mike.gabriel@das-netzwerkteam.de> Date: Fri Sep 14 11:29:52 2018 +0200 x2gobroker/config.py: In API documentation, spell INI in capitals. And some typos and rephrasings. --- x2gobroker/config.py | 32 ++++++++++++++++---------------- 1 file changed, 16 insertions(+), 16 deletions(-) diff --git a/x2gobroker/config.py b/x2gobroker/config.py index 049a0c5..66700f0 100644 --- a/x2gobroker/config.py +++ b/x2gobroker/config.py @@ -22,7 +22,7 @@ # """\ -X2goProcessIniFile - helper class for parsing .ini files +X2GoConfig - helper class for parsing files in INI file format. """ __NAME__ = 'x2goinifiles-pylib' @@ -39,10 +39,10 @@ from x2gobroker.defaults import X2GOBROKER_HOME as _X2GOBROKER_HOME class X2GoBrokerConfigFile(object): """ - Class for processing a ini-file like configuration file. + Class for processing an INI-file-like configuration file. If entries are omitted in such a config file, they are filled with - default values (as hard-coded in Python X2goBroker), so the resulting objects + default values (as hard-coded in Python X2GoBroker), so the resulting objects always contain the same fields. The default values are also used to define a data type for each configuration @@ -63,8 +63,8 @@ class X2GoBrokerConfigFile(object): :param config_files: a list of configuration file names (e.g. a global filename and a user's home directory filename) :type config_files: ``list`` - :param defaults: a cascaded Python dicitionary structure with ini file defaults (to override - Python X2goBroker's hard-coded defaults in L{defaults} + :param defaults: a cascaded Python dicitionary structure with INI file defaults (to override + Python X2GoBroker's hard-coded defaults in L{defaults} :type defaults: ``dict`` """ @@ -130,9 +130,9 @@ class X2GoBrokerConfigFile(object): method. To write the configuration to disk use the L{write()} method. - :param section: the ini file section + :param section: the INI file section :type section: ``str`` - :param key: the ini file key in the given section + :param key: the INI file key in the given section :type key: ``str`` :param value: the value for the given section and key :type value: ``str``, ``list``, ``bool``, ... @@ -167,9 +167,9 @@ class X2GoBrokerConfigFile(object): Change a value for a given section and key. This method does not have any effect on configuration files. - :param section: the ini file section + :param section: the INI file section :type section: ``str`` - :param key: the ini file key in the given section + :param key: the INI file key in the given section :type key: ``str`` :param value: the value for the given section and key :type value: ``str``, ``list``, ``bool``, ... @@ -182,7 +182,7 @@ class X2GoBrokerConfigFile(object): def write(self): """\ - Write the ini file modifications (RawConfigParser object) from RAM to disk. + Write the INI file modifications (RawConfigParser object) from RAM to disk. For writing the first of the ``config_files`` specified on instance construction that is writable will be used. @@ -199,9 +199,9 @@ class X2GoBrokerConfigFile(object): Retrieve a value type for a given section and key. The returned value type is based on the default values dictionary. - :param section: the ini file section + :param section: the INI file section :type section: ``str`` - :param key: the ini file key in the given section + :param key: the INI file key in the given section :type key: ``str`` :returns: a Python variable type @@ -221,9 +221,9 @@ class X2GoBrokerConfigFile(object): Test if a given ``key`` in ``section`` exists (and has some sort of a value). - :param section: the ini file section + :param section: the INI file section :type section: ``str`` - :param key: the ini file key in the given section + :param key: the INI file key in the given section :type key: ``str`` :returns: return ``True`` if <key> in <section> exists @@ -238,9 +238,9 @@ class X2GoBrokerConfigFile(object): """\ Retrieve a value for a given section and key. - :param section: the ini file section + :param section: the INI file section :type section: ``str`` - :param key: the ini file key in the given section + :param key: the INI file key in the given section :type key: ``str`` :returns: the value for the given section and key -- Alioth's /home/x2go-admin/maintenancescripts/git/hooks/post-receive-email on /srv/git/code.x2go.org/x2gobroker.git