Fixing code-annotations (#25539)

* Fixing code-annotations
This commit is contained in:
Manjinder Singh
2020-11-06 12:52:08 -05:00
committed by GitHub
parent d96dedac7a
commit c74b623948
21 changed files with 124 additions and 14 deletions

View File

@@ -96,13 +96,14 @@ REGISTER_USER = Signal(providing_args=["user", "registration"])
# .. toggle_name: registration.enable_failure_logging
# .. toggle_type: flag
# .. toggle_implementation: WaffleFlag
# .. toggle_default: False
# .. toggle_description: Enable verbose logging of registration failure messages
# .. toggle_use_cases: temporary
# .. toggle_creation_date: 2020-04-30
# .. toggle_target_removal_date: 2020-06-01
# .. toggle_warnings: This temporary feature toggle does not have a target removal date.
# .. toggle_tickets: None
REGISTRATION_FAILURE_LOGGING_FLAG = WaffleFlag(
waffle_namespace=WaffleFlagNamespace(name=u'registration'),
flag_name=u'enable_failure_logging',

View File

@@ -30,6 +30,8 @@ class HLSPlaybackEnabledFlag(ConfigurationModel):
.. toggle_description: Add the "hls" profile to all displayed videos on the platform.
.. toggle_use_cases: open_edx
.. toggle_creation_date: 2017-04-19
.. toggle_target_removal_date: None
.. toggle_warnings: None
.. toggle_tickets: https://github.com/edx/edx-platform/pull/14924
"""
# this field overrides course-specific settings
@@ -80,6 +82,8 @@ class CourseHLSPlaybackEnabledFlag(ConfigurationModel):
.. toggle_description: Add the "hls" profile to all displayed videos for a single course.
.. toggle_use_cases: open_edx
.. toggle_creation_date: 2017-04-19
.. toggle_target_removal_date: None
.. toggle_warnings: None
.. toggle_tickets: https://github.com/edx/edx-platform/pull/14924
"""
KEY_FIELDS = ('course_id',)

View File

@@ -16,6 +16,8 @@ WAFFLE_NAMESPACE = 'videos'
# to YouTube as part of the video pipeline.
# .. toggle_use_cases: open_edx
# .. toggle_creation_date: 2018-08-03
# .. toggle_target_removal_date: None
# .. toggle_warnings: None
# .. toggle_tickets: https://github.com/edx/edx-platform/pull/18765
DEPRECATE_YOUTUBE = 'deprecate_youtube'
# .. toggle_name: videos.enable_devstack_video_uploads
@@ -26,6 +28,7 @@ DEPRECATE_YOUTUBE = 'deprecate_youtube'
# of enabling this feature toggle are uncertain.]
# .. toggle_use_cases: open_edx
# .. toggle_creation_date: 2020-03-12
# .. toggle_target_removal_date: None
# .. toggle_warnings: Enabling this feature requires that the ROLE_ARN, MFA_SERIAL_NUMBER, MFA_TOKEN settings are
# properly defined.
# .. toggle_tickets: https://github.com/edx/edx-platform/pull/23375

View File

@@ -24,6 +24,8 @@ class VEMPipelineIntegration(ConfigurationModel):
video pipeline.
.. toggle_use_cases: open_edx
.. toggle_creation_date: 2020-06-04
.. toggle_target_removal_date: None
.. toggle_warnings: None
.. toggle_tickets: https://github.com/edx/edx-platform/pull/24093
"""
client_name = models.CharField(
@@ -66,6 +68,8 @@ class VideoUploadsEnabledByDefault(ConfigurationModel):
enables the "Video Uploads" menu in the CMS.
.. toggle_use_cases: open_edx
.. toggle_creation_date: 2017-11-10
.. toggle_target_removal_date: None
.. toggle_warnings: None
.. toggle_tickets: https://github.com/edx/edx-platform/pull/16536
"""
# this field overrides course-specific settings
@@ -117,6 +121,8 @@ class CourseVideoUploadsEnabledByDefault(ConfigurationModel):
"Video Uploads" menu in the CMS.
.. toggle_use_cases: open_edx
.. toggle_creation_date: 2017-11-10
.. toggle_target_removal_date: None
.. toggle_warnings: None
.. toggle_tickets: https://github.com/edx/edx-platform/pull/16536
"""
KEY_FIELDS = ('course_id',)

View File

@@ -11,6 +11,8 @@ from edx_toggles.toggles import SettingDictToggle
# of the course.
# .. toggle_use_cases: open_edx
# .. toggle_creation_date: 2015-12-01
# .. toggle_target_removal_date: None
# .. toggle_warnings: None
# .. toggle_tickets: https://openedx.atlassian.net/browse/SOL-40
ENTRANCE_EXAMS = SettingDictToggle(
"FEATURES", "ENTRANCE_EXAMS", default=False, module_name=__name__