Skip to content

Commit d92686a

Browse files
docs: add no_pii annotation to models
1 parent 391cd20 commit d92686a

1 file changed

Lines changed: 5 additions & 0 deletions

File tree

openedx_user_groups/models.py

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -75,6 +75,7 @@ class Scope(models.Model):
7575
content_type (ForeignKey): The content type of the object that defines the scope.
7676
object_id (PositiveIntegerField): The ID of the object that defines the scope.
7777
content_object (GenericForeignKey): The object that defines the scope (e.g., course, organization).
78+
.. no_pii:
7879
"""
7980

8081
name = models.CharField(
@@ -101,6 +102,7 @@ class UserGroup(models.Model):
101102
enabled (bool): Whether the user group is enabled.
102103
scope (str): The scope of the user group, defining the context in which it operates.
103104
users (ManyToManyField): The users that are members of the group.
105+
.. no_pii:
104106
"""
105107

106108
name = models.CharField(max_length=255)
@@ -158,6 +160,7 @@ class UserGroupMembership(models.Model):
158160
joined_at (datetime): The timestamp when the user joined the group.
159161
left_at (datetime): The timestamp when the user left the group.
160162
is_active (bool): Whether the user is still a member of the group.
163+
.. no_pii:
161164
"""
162165

163166
user = models.ForeignKey(User, on_delete=models.CASCADE)
@@ -180,6 +183,7 @@ class Criterion(models.Model):
180183
criterion_operator (str): The operator of the criterion.
181184
criterion_config (dict): The configuration of the criterion.
182185
group (UserGroup): The group to which the criterion belongs.
186+
.. no_pii:
183187
"""
184188

185189
criterion_type = models.CharField(
@@ -232,6 +236,7 @@ class GroupCollection(models.Model):
232236
Attributes:
233237
name (str): The name of the group collection.
234238
description (str): A brief description of the group collection.
239+
.. no_pii:
235240
"""
236241

237242
name = models.CharField(max_length=255)

0 commit comments

Comments
 (0)