Skip to content

Commit 5882036

Browse files
📝 Add docstrings to 1124-missing-average-rating
Docstrings generation was requested by @artiehumphreys. * #1125 (comment) The following files were modified: * `tcf_website/views/browse.py`
1 parent 367a7ab commit 5882036

File tree

1 file changed

+11
-1
lines changed

1 file changed

+11
-1
lines changed

‎tcf_website/views/browse.py

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -152,7 +152,17 @@ def course_view(
152152
course_number: int,
153153
instructor_recency=None,
154154
):
155-
"""A new Course view that allows you to input mnemonic and number instead."""
155+
"""
156+
Displays a detailed view for a course or club, including instructors or reviews, based on mnemonic and number.
157+
158+
If viewing a club, retrieves the club by category and ID, fetches and paginates reviews, and renders the club detail page.
159+
If viewing a course, ensures the mnemonic is uppercase, retrieves the course, sorts and processes instructors, prepares navigation breadcrumbs, and renders the course detail page.
160+
161+
Parameters:
162+
mnemonic (str): The course mnemonic or club category slug.
163+
course_number (int): The course number or club ID.
164+
instructor_recency (str, optional): Semester identifier for filtering instructor data; defaults to the latest semester.
165+
"""
156166

157167
mode, is_club = parse_mode(request)
158168

0 commit comments

Comments
 (0)