From 9d5ff1929a1e7586d0ecfe5ab805e37bf1c2de90 Mon Sep 17 00:00:00 2001 From: Johannes Hentschel Date: Fri, 29 Dec 2023 18:44:00 +0100 Subject: [PATCH] docstring --- src/ms3/utils/functions.py | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/src/ms3/utils/functions.py b/src/ms3/utils/functions.py index e5896664..153edb3d 100644 --- a/src/ms3/utils/functions.py +++ b/src/ms3/utils/functions.py @@ -5318,7 +5318,7 @@ def replace_boolean_mode_by_strings(df) -> pd.DataFrame: def resolve_relative_keys(relativeroot, minor=False, logger=None): - """Resolve nested relative keys, e.g. 'V/V/V' => 'VI'. + """Resolve nested relative keys, e.g. 'V/V/V' => 'VI' if minor is False (default) or '#VI' if True. Uses: :py:func:`rel2abs_key`, :py:func:`str_is_minor` @@ -5326,7 +5326,8 @@ def resolve_relative_keys(relativeroot, minor=False, logger=None): One or several relative keys, e.g. iv/v/VI (fourth scale degree of the fifth scale degree of the sixth scale degree) minor : :obj:`bool`, optional - Pass True if the last of the relative keys is to be interpreted within a minor context. + Pass True if the last of the relative keys is to be interpreted within a minor context, and therefore the + result. """ if logger is None: logger = module_logger