Make documentation specify filename without extension

Contributes to issue CURA-844.
This commit is contained in:
Ghostkeeper 2016-07-07 15:22:27 +02:00
parent e6efba3868
commit 8f5e56c66e
No known key found for this signature in database
GPG key ID: 701948C5954A7385
4 changed files with 16 additions and 9 deletions

View file

@ -10,7 +10,8 @@ import UM.VersionUpgrade #To indicate that a file is of the wrong format.
# in version 1 of the file format.
#
# \param serialised The serialised form of a preferences file in version 1.
# \param filename The supposed filename of the preferences file.
# \param filename The supposed filename of the preferences file, without
# extension.
# \return A representation of those preferences, or None if the file format is
# incorrect.
def importFrom(serialised, filename):
@ -25,7 +26,8 @@ class Preferences:
## Reads version 2 of the preferences file format, storing it in memory.
#
# \param serialised A serialised version 2 preferences file.
# \param filename The supposed filename of the preferences file.
# \param filename The supposed filename of the preferences file, without
# extension.
def __init__(self, serialised, filename):
self._filename = filename