Document configdata.Migrations

This commit is contained in:
Florian Bruhin 2018-02-09 11:31:25 +01:00
parent 589605fe92
commit 3e38aab0f6

View File

@ -54,7 +54,12 @@ class Option:
@attr.s
class Migrations:
"""Nigrated options in configdata.yml."""
"""Nigrated options in configdata.yml.
Attributes:
renamed: A dict mapping old option names to new names.
deleted: A list of option names which have been removed.
"""
renamed = attr.ib(default=attr.Factory(dict))
deleted = attr.ib(default=attr.Factory(list))