Skip to content

Commit 5b1e7cf

Browse files
committed
Add note about superproject "action"
1 parent 8dabe0b commit 5b1e7cf

File tree

1 file changed

+2
-0
lines changed

1 file changed

+2
-0
lines changed

readthedocs/api/v3/views.py

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -138,6 +138,8 @@ def get_serializer_class(self):
138138
it return a serializer to validate just a few fields.
139139
"""
140140
if self.action in ('list', 'retrieve', 'superproject'):
141+
# NOTE: ``superproject`` is the @action defined in the
142+
# ProjectViewSet that returns the superproject of a project.
141143
return ProjectSerializer
142144

143145
if self.action in ('create',):

0 commit comments

Comments
 (0)