Update doc string

This commit is contained in:
Phill Ridout 2015-02-13 21:00:55 +00:00
parent 3e697dc213
commit 77109e61fd
1 changed files with 3 additions and 4 deletions

View File

@ -73,10 +73,9 @@ class Settings(QtCore.QSettings):
The first entry is the *old key*; it will be removed. The first entry is the *old key*; it will be removed.
The second entry is the *new key*; we will add it to the config. If this is just an empty string, we just remove The second entry is the *new key*; we will add it to the config. If this is just an empty string, we just remove
the old key. the old key. The last entry is a list containing two-pair tuples. If the list is empty, no conversion is made.
If the first value is callable i.e. a function, the function will be called with the old setting's value.
The last entry is a list containing two-pair tuples. If the list is empty, no conversion is made. Otherwise each Otherwise each pair describes how to convert the old setting's value::
pair describes how to convert the old setting's value::
(SlideLimits.Wrap, True) (SlideLimits.Wrap, True)