Improve documentation for translate function

It says now that the function updates the settings to what they should be in the new version.

Contributes to issue CURA-844.
This commit is contained in:
Ghostkeeper 2016-04-28 13:10:18 +02:00
parent f7ca489877
commit 28da3c1a4f

View file

@ -32,10 +32,11 @@ class VersionUpgrade21to22(VersionUpgrade):
return None
return profile.export()
## Translates settings for the change from Cura 2.1 to 2.2.
## Updates settings for the change from Cura 2.1 to 2.2.
#
# Each setting is changed in-place in the provided dictionary. This
# changes the input parameter.
# The keys and values of settings are changed to what they should be in
# the new version. Each setting is changed in-place in the provided
# dictionary. This changes the input parameter.
#
# \param settings A dictionary of settings (as key-value pairs) to update.
# \return The same dictionary.