Andal.LND/edx-platform
6
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

Improve lms/djangoapps/bulk_email feature toggle documentation

Browse Source
This commit is contained in:
Régis Behmo
2020-08-19 16:22:29 +02:00
parent 6fc322e32f
commit 40e92cc143
1 changed files with 14 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files

26
lms/djangoapps/bulk_email/models.py
View File

@@ -468,18 +468,6 @@ class CourseAuthorization(models.Model):
return u"Course '{}': Instructor Email {}Enabled".format(text_type(self.course_id), not_en)
# .. toggle_name: require_course_email_auth
# .. toggle_implementation: ConfigurationModel
# .. toggle_default: True (enabled)
# .. toggle_description: If the flag is enabled, course-specific authorization is required, and the course_id is either
# not provided or not authorixed, the feature is not available.
# .. toggle_category: bulk email
# .. toggle_use_cases: open_edx
# .. toggle_creation_date: 2016-05-05
# .. toggle_expiration_date: None
# .. toggle_warnings: None
# .. toggle_tickets: None
# .. toggle_status: supported
@python_2_unicode_compatible
class BulkEmailFlag(ConfigurationModel):
"""
@@ -490,6 +478,20 @@ class BulkEmailFlag(ConfigurationModel):
2. Course-specific authorization not required, or course authorized to use bulk email.
.. no_pii:
.. toggle_name: require_course_email_auth
.. toggle_implementation: ConfigurationModel
.. toggle_default: True (enabled)
.. toggle_description: If the flag is enabled, course-specific authorization is
required, and the course_id is either not provided or not authorized, the feature
is not available.
.. toggle_category: bulk email
.. toggle_use_cases: open_edx
.. toggle_creation_date: 2016-05-05
.. toggle_expiration_date: None
.. toggle_warnings: None
.. toggle_tickets: None
.. toggle_status: supported
"""
# boolean field 'enabled' inherited from parent ConfigurationModel
require_course_email_auth = models.BooleanField(default=True)