From e8e5bddf510ec0385535875a399f969bce2f235e Mon Sep 17 00:00:00 2001 From: Jakob Scheid Date: Sun, 15 Mar 2026 23:11:44 +0100 Subject: [PATCH] Format docstring in `parse_ini` in `src/jcloud_config_parser/parse/ini.py` correctly --- src/jcloud_config_parser/parse/ini.py | 21 +++++++++++---------- 1 file changed, 11 insertions(+), 10 deletions(-) diff --git a/src/jcloud_config_parser/parse/ini.py b/src/jcloud_config_parser/parse/ini.py index b3d9fd2..ed747b6 100644 --- a/src/jcloud_config_parser/parse/ini.py +++ b/src/jcloud_config_parser/parse/ini.py @@ -143,20 +143,21 @@ def _compress_conf(conf): return conf.strip() def parse_ini(conf, comment_prefixes=_COMMENT_PREFIXES, quotation_marks=_QUOTATION_MARKS, ignore_errors: bool = False, global_group: bool = True) -> typing.Dict[str, typing.Dict[str, str]]: - '''Parses INI configuration from a string and returns a nested dictionary. + ''' + Parses INI configuration from a string and returns a nested dictionary. -:param conf: The INI configuration string to parse. -:param comment_prefixes: A collection of prefixes that denote comments in the INI file. -:param quotation_marks: A collection of characters used for quoting values in the INI file. -:param ignore_errors: If True, parsing errors will be ignored. -:param global_group: If True, key-value pairs outside of any group will be included. Otherwise, an exception will be raised. + :param conf: The INI configuration string to parse. + :param comment_prefixes: A collection of prefixes that denote comments in the INI file. + :param quotation_marks: A collection of characters used for quoting values in the INI file. + :param ignore_errors: If True, parsing errors will be ignored. + :param global_group: If True, key-value pairs outside of any group will be included. Otherwise, an exception will be raised. -:return: A nested dictionary representing the parsed INI configuration. + :return: A nested dictionary representing the parsed INI configuration. -:raises INISyntaxError: If there is a syntax error in the INI configuration and ignore_errors is False. + :raises INISyntaxError: If there is a syntax error in the INI configuration and ignore_errors is False. -:rtype: typing.Dict[str, typing.Dict[str, str]] -''' + :rtype: typing.Dict[str, typing.Dict[str, str]] + ''' conf = _compress_conf(conf) result = {}