From 81df313f3aa485f1f53b3bc0d9388fc60043774f Mon Sep 17 00:00:00 2001 From: Ghostkeeper Date: Wed, 1 Apr 2020 14:58:30 +0200 Subject: [PATCH] Fix documentation for upgrade functions There are no settings to rename. That documentation was outdated. --- .../VersionUpgrade45to46.py | 33 ++++++++++++++----- 1 file changed, 25 insertions(+), 8 deletions(-) diff --git a/plugins/VersionUpgrade/VersionUpgrade45to46/VersionUpgrade45to46.py b/plugins/VersionUpgrade/VersionUpgrade45to46/VersionUpgrade45to46.py index 877cf22aaf..2234dd35f5 100644 --- a/plugins/VersionUpgrade/VersionUpgrade45to46/VersionUpgrade45to46.py +++ b/plugins/VersionUpgrade/VersionUpgrade45to46/VersionUpgrade45to46.py @@ -18,10 +18,16 @@ class VersionUpgrade45to46(VersionUpgrade): setting_version = int(parser.get("metadata", "setting_version", fallback = "0")) return format_version * 1000000 + setting_version - ## Upgrades Preferences to have the new version number. - # - # This renames the renamed settings in the list of visible settings. def upgradePreferences(self, serialized: str, filename: str) -> Tuple[List[str], List[str]]: + """ + Upgrades preferences to have the new version number. + + This removes any settings that were removed in the new Cura version. + :param serialized: The original contents of the preferences file. + :param filename: The file name of the preferences file. + :return: A list of new file names, and a list of the new contents for + those files. + """ parser = configparser.ConfigParser(interpolation = None) parser.read_string(serialized) @@ -39,11 +45,16 @@ class VersionUpgrade45to46(VersionUpgrade): parser.write(result) return [filename], [result.getvalue()] - ## Upgrades instance containers to have the new version - # number. - # - # This renames the renamed settings in the containers. def upgradeInstanceContainer(self, serialized: str, filename: str) -> Tuple[List[str], List[str]]: + """ + Upgrades instance containers to have the new version number. + + This removes any settings that were removed in the new Cura version. + :param serialized: The original contents of the instance container. + :param filename: The original file name of the instance container. + :return: A list of new file names, and a list of the new contents for + those files. + """ parser = configparser.ConfigParser(interpolation = None, comment_prefixes = ()) parser.read_string(serialized) @@ -59,8 +70,14 @@ class VersionUpgrade45to46(VersionUpgrade): parser.write(result) return [filename], [result.getvalue()] - ## Upgrades stacks to have the new version number. def upgradeStack(self, serialized: str, filename: str) -> Tuple[List[str], List[str]]: + """ + Upgrades stacks to have the new version number. + :param serialized: The original contents of the stack. + :param filename: The original file name of the stack. + :return: A list of new file names, and a list of the new contents for + those files. + """ parser = configparser.ConfigParser(interpolation = None) parser.read_string(serialized)