more useful explanatory comments

2 files changed, 4 insertions, 0 deletions

diff --git a/ctrack/users/tests/test_views.py b/ctrack/users/tests/test_views.py
index ca2d0c2..f8e7e78 100644
--- a/ctrack/users/tests/test_views.py
+++ b/ctrack/users/tests/test_views.py
@@ -67,7 +67,9 @@ def test_profile_view_contains_organisation_information(person):
     # Django Advanced Testing Topics
     request.user = user
 
+    # We pass 'username' rather than 'slug' here because we are setting 'slug_url_kwarg' in our CBV.
     response = UserDetailView.as_view()(request, username=user.username)
+
     assert response.status_code == 200
     assert response.context_data["user"].username == "testy"
     assert response.context_data["user"].is_stakeholder() is True
diff --git a/ctrack/users/views.py b/ctrack/users/views.py
index fcc0e84..ed29ea1 100644
--- a/ctrack/users/views.py
+++ b/ctrack/users/views.py
@@ -16,6 +16,8 @@ class UserDetailView(LoginRequiredMixin, DetailView):
     # citizen to be used in a URL
     slug_field = "username"
 
+    # the name of the URLConf keyword argument that contains the slug. By default, slug_url_kwarg is 'slug'.
+    # we have to pass 'username' as the argument when testing UserDetailView because of this.
     slug_url_kwarg = "username"