Added docs to clearly state the misleading name of `SubscriptionQuery…

…Set.active()`
opengisch · Feb 20, 2023 · cb60477 · cb60477
1 parent 962621d
commit cb60477
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/docker-app/qfieldcloud/subscription/models.py b/docker-app/qfieldcloud/subscription/models.py
@@ -319,6 +319,11 @@ class Package(models.Model):
 
 class SubscriptionQuerySet(models.QuerySet):
  def active(self):
+ """Returns the subscriptions which are relevant to the current moment.
+
+ WARNING the name `active` is super misleading, should be `current`. Some of the subscriptions in the queryset might not be active, but cancelled or drafted.
+ TODO rename to `current`
+ """
  now = timezone.now()
  qs = self.filter(
  Q(active_since__lte=now)