From f67ca080800b87f992bc437e28ca4646884996f5 Mon Sep 17 00:00:00 2001
From: Klaas van Schelven <klaas@vanschelven.com>
Date: Fri, 27 Sep 2024 21:27:44 +0200
Subject: [PATCH] Document what a 'sort_epoch' is

---
 releases/models.py | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/releases/models.py b/releases/models.py
index fd106df..0900d8e 100644
--- a/releases/models.py
+++ b/releases/models.py
@@ -55,6 +55,10 @@ class Release(models.Model):
 
     semver = models.CharField(max_length=255, null=False, editable=False)
     is_semver = models.BooleanField(editable=False)
+
+    # sort_epoch is a way to ensure that we can sort releases alternatingly by date and by semver. The idea is that
+    # whenever we switch from one to the other, we increment the epoch. This way, we can sort releases by epoch first
+    # and then by date or semver.
     sort_epoch = models.IntegerField(editable=False)
 
     def save(self, *args, **kwargs):