Skip to content

Commit dfde552

Browse files
committed
remove comments, add docstrings
1 parent 1c61329 commit dfde552

1 file changed

Lines changed: 4 additions & 3 deletions

File tree

news/mixins.py

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ class NewsQuerysetMixin:
1313
"""
1414

1515
def get_queryset_for_project(self):
16+
"""Returns queryset of news for project"""
1617
project_pk = self.kwargs.get("project_pk")
1718
try:
1819
project = Project.objects.get(pk=project_pk)
@@ -22,6 +23,7 @@ def get_queryset_for_project(self):
2223
return News.objects.get_news(obj=project)
2324

2425
def get_queryset_for_program(self):
26+
"""Returns queryset of news for partner program"""
2527
partnerprogram_pk = self.kwargs.get("partnerprogram_pk")
2628
try:
2729
program = PartnerProgram.objects.get(pk=partnerprogram_pk)
@@ -31,6 +33,7 @@ def get_queryset_for_program(self):
3133
return News.objects.get_news(obj=program)
3234

3335
def get_queryset_for_user(self):
36+
"""Returns queryset of news for user"""
3437
user_pk = self.kwargs.get("user_pk")
3538
try:
3639
user = User.objects.get(pk=user_pk)
@@ -40,14 +43,12 @@ def get_queryset_for_user(self):
4043
return News.objects.get_news(obj=user)
4144

4245
def get_queryset(self):
46+
"""Chooses what queryset to return - for project, program or user"""
4347
if self.kwargs.get("project_pk") is not None:
44-
# it's a project
4548
return self.get_queryset_for_project()
4649
elif self.kwargs.get("partnerprogram_pk") is not None:
47-
# it's a partner program
4850
return self.get_queryset_for_program()
4951
elif self.kwargs.get("user_pk") is not None:
50-
# it's a user news
5152
return self.get_queryset_for_user()
5253
else:
5354
return News.objects.none()

0 commit comments

Comments
 (0)