Add documentation

This commit is contained in:
2020-05-18 14:22:52 +02:00
parent 2fa124f529
commit e761864c3e
19 changed files with 621 additions and 9 deletions

View File

@ -9,6 +9,19 @@ import collections
# Create your models here.
class Schedule(MetaDataModel):
"""
A model that holds the schedule information. Here we store the form data and let the Peregrine cluster make the calculations.
It will inherit the attributes :attr:`~lib.models.base.MetaDataModel.created_at` and :attr:`~lib.models.base.MetaDataModel.updated_at` from the Abstract model :class:`~lib.models.base.MetaDataModel`
Attributes
----------
employee : Employee
The employee that is the owner of this schedule.
name : str
The name of the schedule. Max length is 100 characters.
email : str
The email address where the results should be sent to. Max length is 100 characters.
"""
class Meta:
verbose_name = _('schedule')