Merge pull request #10510 from edx/peter-fogg/update-cert-info-docstring

Update `cert_info` docstring with correct return type.
This commit is contained in:
Peter Fogg
2015-11-04 12:07:49 -05:00

View File

@@ -194,7 +194,7 @@ def cert_info(user, course_overview, course_mode):
course_mode (str): The enrollment mode (honor, verified, audit, etc.)
Returns:
dict: A dictionary with keys:
dict: Empty dict if certificates are disabled or hidden, or a dictionary with keys:
'status': one of 'generating', 'ready', 'notpassing', 'processing', 'restricted'
'show_download_url': bool
'download_url': url, only present if show_download_url is True