Add docstring to describe models

backend/boards/models.py

@@ -3,6 +3,13 @@ from django.db import models
 from users.models import CustomUser
 
 class Board(models.Model):
+    """
+    Kanban board model.
+
+    :param user: The user who owns the board.
+    :param name: The name of the board.
+    :param created_at: The date and time when the board was created.
+    """
     user = models.ForeignKey(CustomUser, on_delete=models.CASCADE)
     name = models.CharField(max_length=255)
     created_at = models.DateTimeField(auto_now_add=True)
@@ -12,6 +19,13 @@ class Board(models.Model):
 
 
 class ListBoard(models.Model):
+    """
+    List inside a Kanban board.
+
+    :param board: The board that the list belongs to.
+    :param name: The name of the list.
+    :param position: The position of the list in Kanban.
+    """
     board = models.ForeignKey(Board, on_delete=models.CASCADE)
     name = models.CharField(max_length=255)
     position = models.IntegerField()

backend/tasks/models.py

@@ -49,7 +49,18 @@ class Task(models.Model):
 
 
 class Todo(Task):
+    """
+    Represent a Todo task.
 
+    :param list_board: The list board that the task belongs to.
+    :param is_active: A boolean field indicating whether the task is active. (Archive or not)
+    :param is_full_day_event: A boolean field indicating whether the task is a full day event.
+    :param start_event: Start date and time of the task.
+    :param end_event: End date and time of the task.
+    :param google_calendar_id: The Google Calendar ID of the task.
+    :param completed: A boolean field indicating whether the task is completed.
+    :param priority: The priority of the task (range: 1 to 4).
+    """
     class EisenhowerMatrix(models.IntegerChoices):
         IMPORTANT_URGENT = 1, 'Important & Urgent'
         IMPORTANT_NOT_URGENT = 2, 'Important & Not Urgent'
@@ -69,6 +80,18 @@ class Todo(Task):
         return self.title
 
 class RecurrenceTask(Task):
+    """
+    Represent a Recurrence task. (Occure every day, week, month, year)
+
+    :param list_board: The list board that the task belongs to.
+    :param rrule: The recurrence rule of the task.
+    :param is_active: A boolean field indicating whether the task is active. (Archive or not)
+    :param is_full_day_event: A boolean field indicating whether the task is a full day event.
+    :param start_event: Start date and time of the task.
+    :param end_event: End date and time of the task.
+    :param completed: A boolean field indicating whether the task is completed.
+    :param parent_task: The parent task of the subtask.
+    """
     list_board = models.ForeignKey(ListBoard, on_delete=models.CASCADE, null=True, default=1)
     rrule = models.CharField(max_length=255, null=True, blank=True)
     is_active = models.BooleanField(default=True)
@@ -83,6 +106,15 @@ class RecurrenceTask(Task):
 
 
 class RecurrencePattern(models.Model):
+    """
+    :param recurrence_task: The recurrence task that the pattern belongs to.
+    :param recurring_type: The type of recurrence.
+    :param max_occurrences: The maximum number of occurrences.
+    :param day_of_week: The day of the week that event will occure.
+    :param week_of_month: The week of the month that event will occure.
+    :param day_of_month: The day of the month that event will occure.
+    :param month_of_year: The month of the year that event will occure.
+    """
     class RecurringType(models.IntegerChoices):
         DAILY = 0, 'Daily'
         WEEKLY = 1, 'Weekly'
@@ -129,6 +161,12 @@ class RecurrencePattern(models.Model):
 
 
 class Habit(Task):
+    """
+    Represent a Habit task with streaks.
+
+    :param streak: The streak of the habit.
+    :param current_count: The current count of the habit.
+    """
     streak = models.IntegerField(default=0)
     current_count = models.IntegerField(default=0)
 

backend/users/models.py

@@ -10,7 +10,9 @@ from .managers import CustomAccountManager
 
 
 class CustomUser(AbstractBaseUser, PermissionsMixin):
-    # User fields
+    """
+    User model where email is the unique identifier for authentication.
+    """
     email = models.EmailField(_('email address'), unique=True)
     username = models.CharField(max_length=150, unique=True)
     first_name = models.CharField(max_length=150, blank=True)