ynerant/nk20
1
0
Fork 0
mirror of https://gitlab.crans.org/bde/nk20 synced 2025-06-21 09:58:23 +02:00
Code Issues Releases Wiki Activity

Add/ Complete docstring for every models.

Browse Source
This commit is contained in:
Pierre-antoine Comby
2020-01-21 22:06:06 +01:00
parent 7764abc0c0
commit 5a7d779a90
4 changed files with 56 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
apps/activity/models.py
View File

@ -9,7 +9,12 @@ from django.utils.translation import gettext_lazy as _
class ActivityType(models.Model):
"""
Type of Activity, (e.g "Pot", "Soirée Club") and associated properties
Type of Activity, (e.g "Pot", "Soirée Club") and associated properties.
Activity Type are used as a search field for Activity, and determine how
some rules about the activity:
- Can people be invited
- What is the entrance fee.
"""
name = models.CharField(
verbose_name=_('name'),
@ -32,7 +37,9 @@ class ActivityType(models.Model):
class Activity(models.Model):
"""
An IRL event organized by a club for others.
An IRL event organized by a club for other club.
By default the invited clubs should be the Club containing all the active accounts.
"""
name = models.CharField(
verbose_name=_('name'),
@ -73,7 +80,7 @@ class Activity(models.Model):
class Guest(models.Model):
"""
People who are not current members of any clubs, and invited by someone who is a current member.
People who are not current members of any clubs, and are invited by someone who is a current member.
"""
activity = models.ForeignKey(
Activity,
@ -92,6 +99,7 @@ class Guest(models.Model):
null=True,
)
entry_transaction = models.ForeignKey(
null=True,
'note.Transaction',
on_delete=models.PROTECT,
)