From fadc9618d4df8cc1b7c6d94158d1c8c26e523337 Mon Sep 17 00:00:00 2001 From: Andy Shultz Date: Tue, 17 Oct 2023 14:01:06 -0400 Subject: [PATCH] docs: fix old course_id arg description to modern(2015) usage the code asserts that this is a key rather than a string --- common/djangoapps/student/models/course_enrollment.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/common/djangoapps/student/models/course_enrollment.py b/common/djangoapps/student/models/course_enrollment.py index f4cd5dcc99..f4ef557afd 100644 --- a/common/djangoapps/student/models/course_enrollment.py +++ b/common/djangoapps/student/models/course_enrollment.py @@ -330,7 +330,7 @@ class CourseEnrollment(models.Model): attribute), this method will automatically save it before adding an enrollment for it. - `course_id` is our usual course_id string (e.g. "edX/Test101/2013_Fall) + `course_key` must be a opaque_keys CourseKey object. It is expected that this method is called from a method which has already verified the user authentication and access.