diff --git a/cms/djangoapps/contentstore/config/waffle.py b/cms/djangoapps/contentstore/config/waffle.py index a7e303d64bc9..8f431fa49327 100644 --- a/cms/djangoapps/contentstore/config/waffle.py +++ b/cms/djangoapps/contentstore/config/waffle.py @@ -34,7 +34,7 @@ # .. toggle_use_cases: temporary, open_edx # .. toggle_creation_date: 2020-08-03 # .. toggle_target_removal_date: 2020-12-31 -# .. toggle_warnings: Also set settings.LIBRARY_AUTHORING_MICROFRONTEND_URL and ENABLE_LIBRARY_AUTHORING_MICROFRONTEND. +# .. toggle_warning: Also set settings.LIBRARY_AUTHORING_MICROFRONTEND_URL and ENABLE_LIBRARY_AUTHORING_MICROFRONTEND. # .. toggle_tickets: https://openedx.atlassian.net/wiki/spaces/COMM/pages/1545011241/BD-14+Blockstore+Powered+Content+Libraries+Taxonomies REDIRECT_TO_LIBRARY_AUTHORING_MICROFRONTEND = WaffleFlag( f'{WAFFLE_NAMESPACE}.library_authoring_mfe', __name__, LOG_PREFIX @@ -50,6 +50,6 @@ # .. toggle_use_cases: temporary # .. toggle_creation_date: 2021-07-12 # .. toggle_target_removal_date: 2021-12-31 -# .. toggle_warnings: Flag course_experience.relative_dates should also be active for relative dates functionalities to work. +# .. toggle_warning: Flag course_experience.relative_dates should also be active for relative dates functionalities to work. # .. toggle_tickets: https://openedx.atlassian.net/browse/AA-844 CUSTOM_RELATIVE_DATES = CourseWaffleFlag(f'{WAFFLE_NAMESPACE}.custom_relative_dates', __name__) diff --git a/cms/djangoapps/contentstore/toggles.py b/cms/djangoapps/contentstore/toggles.py index e67e12a6e3a6..5aabca4c90c7 100644 --- a/cms/djangoapps/contentstore/toggles.py +++ b/cms/djangoapps/contentstore/toggles.py @@ -11,7 +11,7 @@ # valid "giturl" attribute. Exporting a course to git causes the course to be exported in the directory indicated by # the GIT_REPO_EXPORT_DIR setting. Note that when this feature is disabled, courses can still be exported to git with # the git_export management command. -# .. toggle_warnings: To enable this feature, the GIT_REPO_EXPORT_DIR setting must be properly defined and point to an +# .. toggle_warning: To enable this feature, the GIT_REPO_EXPORT_DIR setting must be properly defined and point to an # existing directory. # .. toggle_use_cases: open_edx # .. toggle_creation_date: 2014-02-13 @@ -70,7 +70,7 @@ def bypass_olx_failure_enabled(): # .. toggle_implementation: SettingDictToggle # .. toggle_default: False # .. toggle_description: When enabled, users can access the new course authoring view for proctoring exams -# .. toggle_warnings: None +# .. toggle_warning: None # .. toggle_creation_date: 2020-07-23 ENABLE_EXAM_SETTINGS_HTML_VIEW = SettingDictToggle( "FEATURES", "ENABLE_EXAM_SETTINGS_HTML_VIEW", default=False, module_name=__name__ @@ -92,7 +92,7 @@ def exam_setting_view_enabled(): # .. toggle_creation_date: 2021-12-1 # .. toggle_target_removal_date: 2022-1-30 # .. toggle_tickets: TNL-9306 -# .. toggle_warnings: +# .. toggle_warning: ENABLE_NEW_TEXT_EDITOR_FLAG = WaffleFlag('new_core_editors.use_new_text_editor', __name__) @@ -111,7 +111,7 @@ def use_new_text_editor(): # .. toggle_creation_date: 2021-12-1 # .. toggle_target_removal_date: 2022-1-30 # .. toggle_tickets: TNL-9306 -# .. toggle_warnings: +# .. toggle_warning: ENABLE_NEW_VIDEO_EDITOR_FLAG = WaffleFlag('new_core_editors.use_new_video_editor', __name__) @@ -130,7 +130,7 @@ def use_new_video_editor(): # .. toggle_creation_date: 2021-12-1 # .. toggle_target_removal_date: 2022-1-30 # .. toggle_tickets: TNL-9306 -# .. toggle_warnings: +# .. toggle_warning: ENABLE_NEW_PROBLEM_EDITOR_FLAG = WaffleFlag('new_core_editors.use_new_problem_editor', __name__) diff --git a/cms/envs/common.py b/cms/envs/common.py index 404a0c34e070..876fe559aa0e 100644 --- a/cms/envs/common.py +++ b/cms/envs/common.py @@ -404,7 +404,7 @@ # .. toggle_creation_date: 2020-03-03 # .. toggle_target_removal_date: None # .. toggle_tickets: https://openedx.atlassian.net/browse/EDUCATOR-4951 - # .. toggle_warnings: This temporary feature toggle does not have a target removal date. + # .. toggle_warning: This temporary feature toggle does not have a target removal date. 'ENABLE_ORA_ALL_FILE_URLS': False, # .. toggle_name: FEATURES['ENABLE_ORA_USER_STATE_UPLOAD_DATA'] @@ -416,7 +416,7 @@ # .. toggle_creation_date: 2020-03-03 # .. toggle_target_removal_date: None # .. toggle_tickets: https://openedx.atlassian.net/browse/EDUCATOR-4951 - # .. toggle_warnings: This temporary feature toggle does not have a target removal date. + # .. toggle_warning: This temporary feature toggle does not have a target removal date. 'ENABLE_ORA_USER_STATE_UPLOAD_DATA': False, # .. toggle_name: FEATURES['DEPRECATE_OLD_COURSE_KEYS_IN_STUDIO'] @@ -430,7 +430,7 @@ # .. toggle_use_cases: temporary # .. toggle_creation_date: 2020-06-12 # .. toggle_target_removal_date: 2021-04-01 - # .. toggle_warnings: This can be removed once support is removed for deprecated + # .. toggle_warning: This can be removed once support is removed for deprecated # course keys. # .. toggle_tickets: https://openedx.atlassian.net/browse/DEPR-58 'DEPRECATE_OLD_COURSE_KEYS_IN_STUDIO': True, @@ -443,7 +443,7 @@ # .. toggle_creation_date: 2020-06-20 # .. toggle_target_removal_date: 2020-12-31 # .. toggle_tickets: https://openedx.atlassian.net/wiki/spaces/COMM/pages/1545011241/BD-14+Blockstore+Powered+Content+Libraries+Taxonomies - # .. toggle_warnings: Also set settings.LIBRARY_AUTHORING_MICROFRONTEND_URL and see + # .. toggle_warning: Also set settings.LIBRARY_AUTHORING_MICROFRONTEND_URL and see # REDIRECT_TO_LIBRARY_AUTHORING_MICROFRONTEND for rollout. 'ENABLE_LIBRARY_AUTHORING_MICROFRONTEND': False, @@ -456,7 +456,7 @@ # otherwise the course creation functionality will work as it should. # .. toggle_use_cases: open_edx # .. toggle_creation_date: 2013-12-02 - # .. toggle_warnings: Another toggle DISABLE_LIBRARY_CREATION overrides DISABLE_COURSE_CREATION, if present. + # .. toggle_warning: Another toggle DISABLE_LIBRARY_CREATION overrides DISABLE_COURSE_CREATION, if present. 'DISABLE_COURSE_CREATION': False, # Can be turned off to disable the help link in the navbar @@ -501,7 +501,7 @@ # .. toggle_creation_date: 2022-03-22 # .. toggle_target_removal_date: None # .. toggle_tickets: https://github.com/edx/edx-platform/pull/28268 - # .. toggle_warnings: For consistency in user-experience, keep the value in sync with the setting of the same name + # .. toggle_warning: For consistency in user-experience, keep the value in sync with the setting of the same name # in the LMS and CMS. 'MARK_LIBRARY_CONTENT_BLOCK_COMPLETE_ON_VIEW': False, @@ -512,7 +512,7 @@ # This also hides the "Unenroll" button on the Learner Dashboard. # .. toggle_use_cases: open_edx # .. toggle_creation_date: 2021-10-11 - # .. toggle_warnings: For consistency in user experience, keep the value in sync with the setting of the same name + # .. toggle_warning: For consistency in user experience, keep the value in sync with the setting of the same name # in the LMS and CMS. # .. toggle_tickets: 'https://github.com/open-craft/edx-platform/pull/429' 'DISABLE_UNENROLLMENT': False, @@ -2578,7 +2578,7 @@ # .. toggle_use_cases: temporary # .. toggle_creation_date: 2019-12-02 # .. toggle_target_removal_date: 2020-06-01 -# .. toggle_warnings: This url can be removed once it no longer has any real traffic. +# .. toggle_warning: This url can be removed once it no longer has any real traffic. # .. toggle_tickets: ARCH-1253 DISABLE_DEPRECATED_SIGNIN_URL = False @@ -2589,7 +2589,7 @@ # .. toggle_use_cases: temporary # .. toggle_creation_date: 2019-12-02 # .. toggle_target_removal_date: 2020-06-01 -# .. toggle_warnings: This url can be removed once it no longer has any real traffic. +# .. toggle_warning: This url can be removed once it no longer has any real traffic. # .. toggle_tickets: ARCH-1253 DISABLE_DEPRECATED_SIGNUP_URL = False diff --git a/common/djangoapps/course_modes/views.py b/common/djangoapps/course_modes/views.py index 7569f4d80c75..7322483b8d8d 100644 --- a/common/djangoapps/course_modes/views.py +++ b/common/djangoapps/course_modes/views.py @@ -55,7 +55,7 @@ # .. toggle_creation_date: 2021-8-23 # .. toggle_target_removal_date: None # .. toggle_tickets: REV-2133 -# .. toggle_warnings: This temporary feature toggle does not have a target removal date. +# .. toggle_warning: This temporary feature toggle does not have a target removal date. VALUE_PROP_TRACK_SELECTION_FLAG = WaffleFlag('course_modes.use_new_track_selection', __name__) diff --git a/common/djangoapps/student/admin.py b/common/djangoapps/student/admin.py index b6546fc672a9..72a8be52ce6a 100644 --- a/common/djangoapps/student/admin.py +++ b/common/djangoapps/student/admin.py @@ -54,7 +54,7 @@ # .. toggle_implementation: WaffleSwitch # .. toggle_default: False # .. toggle_description: This toggle will enable the rendering of the admin view of the CourseEnrollment model. -# .. toggle_warnings: Enabling this toggle may cause performance problems. The CourseEnrollment admin view +# .. toggle_warning: Enabling this toggle may cause performance problems. The CourseEnrollment admin view # makes DB queries that could cause site outages for a large enough Open edX installation. # .. toggle_use_cases: opt_in, open_edx # .. toggle_creation_date: 2018-08-01 diff --git a/doc.rst.j2 b/doc.rst.j2 index b4bd36750971..f0aaa6d9096b 100644 --- a/doc.rst.j2 +++ b/doc.rst.j2 @@ -12,8 +12,8 @@ These are all of our well-documented feature toggles! * Type: {{ group.toggle_type[0] }} * Use cases: {{ group.toggle_use_cases|join(", ") }} -{% if group.toggle_warnings != 'None' -%} -* Warnings: {{ group.toggle_warnings }} +{% if group.toggle_warning != 'None' -%} +* Warnings: {{ group.toggle_warning }} {% endif -%} {% if group.toggle_target_removal_date != 'None' -%} * Expiration date: {{ group.toggle_target_removal_date }} diff --git a/lms/djangoapps/course_api/blocks/toggles.py b/lms/djangoapps/course_api/blocks/toggles.py index 35a38ffeaad0..10ea161d7b6b 100644 --- a/lms/djangoapps/course_api/blocks/toggles.py +++ b/lms/djangoapps/course_api/blocks/toggles.py @@ -14,7 +14,7 @@ # .. toggle_use_cases: temporary, open_edx # .. toggle_creation_date: 2019-09-27 # .. toggle_target_removal_date: None -# .. toggle_warnings: This temporary feature toggle does not have a target removal date. +# .. toggle_warning: This temporary feature toggle does not have a target removal date. HIDE_ACCESS_DENIALS_FLAG = WaffleFlag( f'{COURSE_BLOCKS_API_NAMESPACE}.hide_access_denials', __name__ ) diff --git a/lms/djangoapps/courseware/toggles.py b/lms/djangoapps/courseware/toggles.py index 732132866d54..01d9128bf868 100644 --- a/lms/djangoapps/courseware/toggles.py +++ b/lms/djangoapps/courseware/toggles.py @@ -19,7 +19,7 @@ # .. toggle_use_cases: open_edx, temporary # .. toggle_creation_date: 2020-10-02 # .. toggle_target_removal_date: None -# .. toggle_warnings: Also set settings.LEARNING_MICROFRONTEND_URL. +# .. toggle_warning: Also set settings.LEARNING_MICROFRONTEND_URL. # .. toggle_tickets: AA-188 COURSEWARE_MICROFRONTEND_COURSE_EXIT_PAGE = CourseWaffleFlag( f'{WAFFLE_FLAG_NAMESPACE}.microfrontend_course_exit_page', __name__ @@ -33,7 +33,7 @@ # .. toggle_use_cases: temporary, open_edx # .. toggle_creation_date: 2020-10-07 # .. toggle_target_removal_date: none -# .. toggle_warnings: Also set settings.LEARNING_MICROFRONTEND_URL. +# .. toggle_warning: Also set settings.LEARNING_MICROFRONTEND_URL. # .. toggle_tickets: AA-371 COURSEWARE_MICROFRONTEND_PROGRESS_MILESTONES = CourseWaffleFlag( f'{WAFFLE_FLAG_NAMESPACE}.mfe_progress_milestones', __name__ @@ -48,7 +48,7 @@ # .. toggle_use_cases: temporary, open_edx # .. toggle_creation_date: 2021-02-16 # .. toggle_target_removal_date: None -# .. toggle_warnings: Also set settings.LEARNING_MICROFRONTEND_URL and +# .. toggle_warning: Also set settings.LEARNING_MICROFRONTEND_URL and # COURSEWARE_MICROFRONTEND_PROGRESS_MILESTONES. # .. toggle_tickets: AA-304 COURSEWARE_MICROFRONTEND_PROGRESS_MILESTONES_STREAK_CELEBRATION = CourseWaffleFlag( @@ -59,7 +59,7 @@ # .. toggle_implementation: CourseWaffleFlag # .. toggle_default: False # .. toggle_description: This flag enables an engagement discount incentive message. -# .. toggle_warnings: This flag depends on the streak celebration feature being enabled +# .. toggle_warning: This flag depends on the streak celebration feature being enabled # .. toggle_use_cases: opt_out, open_edx # .. toggle_creation_date: 2021-08-26 # .. toggle_target_removal_date: None diff --git a/lms/djangoapps/experiments/utils.py b/lms/djangoapps/experiments/utils.py index f8b9f4b071ef..30397c7bbd4a 100644 --- a/lms/djangoapps/experiments/utils.py +++ b/lms/djangoapps/experiments/utils.py @@ -35,7 +35,7 @@ # .. toggle_creation_date: 2019-2-25 # .. toggle_target_removal_date: None # .. toggle_tickets: REVEM-63, REVEM-198 -# .. toggle_warnings: This temporary feature toggle does not have a target removal date. +# .. toggle_warning: This temporary feature toggle does not have a target removal date. PROGRAM_INFO_FLAG = WaffleFlag( 'experiments.add_programs', __name__, @@ -49,7 +49,7 @@ # .. toggle_creation_date: 2019-3-28 # .. toggle_target_removal_date: None # .. toggle_tickets: REVEM-118 -# .. toggle_warnings: This temporary feature toggle does not have a target removal date. +# .. toggle_warning: This temporary feature toggle does not have a target removal date. DASHBOARD_INFO_FLAG = WaffleFlag('experiments.add_dashboard_info', __name__) # TODO END: clean up as part of REVEM-199 (End) @@ -62,7 +62,7 @@ # .. toggle_creation_date: 2020-7-7 # .. toggle_target_removal_date: None # .. toggle_tickets: REV-1205 -# .. toggle_warnings: This temporary feature toggle does not have a target removal date. +# .. toggle_warning: This temporary feature toggle does not have a target removal date. UPSELL_TRACKING_FLAG = WaffleFlag( 'experiments.add_upsell_tracking', __name__, diff --git a/lms/djangoapps/experiments/views_custom.py b/lms/djangoapps/experiments/views_custom.py index def5621df883..ee7d14dd48a5 100644 --- a/lms/djangoapps/experiments/views_custom.py +++ b/lms/djangoapps/experiments/views_custom.py @@ -32,7 +32,7 @@ # .. toggle_creation_date: 2019-09-05 # .. toggle_target_removal_date: None # .. toggle_tickets: REV-934 -# .. toggle_warnings: This temporary feature toggle does not have a target removal date. +# .. toggle_warning: This temporary feature toggle does not have a target removal date. MOBILE_UPSELL_FLAG = WaffleFlag('experiments.mobile_upsell_rev934', __name__) MOBILE_UPSELL_EXPERIMENT = 'mobile_upsell_experiment' diff --git a/lms/djangoapps/grades/config/waffle.py b/lms/djangoapps/grades/config/waffle.py index 4cc46e9dea54..ced1f4a228a0 100644 --- a/lms/djangoapps/grades/config/waffle.py +++ b/lms/djangoapps/grades/config/waffle.py @@ -23,7 +23,7 @@ # .. toggle_use_cases: open_edx # .. toggle_creation_date: 2017-04-11 # .. toggle_tickets: https://github.com/edx/edx-platform/pull/14771 -# .. toggle_warnings: This requires the PersistentGradesEnabledFlag to be enabled. +# .. toggle_warning: This requires the PersistentGradesEnabledFlag to be enabled. ASSUME_ZERO_GRADE_IF_ABSENT = WaffleSwitch(f'{WAFFLE_NAMESPACE}.assume_zero_grade_if_absent', __name__) # .. toggle_name: grades.disable_regrade_on_policy_change # .. toggle_implementation: WaffleSwitch @@ -69,7 +69,7 @@ # .. toggle_use_cases: open_edx # .. toggle_creation_date: 2018-10-03 # .. toggle_tickets: https://github.com/edx/edx-platform/pull/19054 -# .. toggle_warnings: Enabling this requires that the `WRITABLE_GRADEBOOK_URL` setting be properly defined. +# .. toggle_warning: Enabling this requires that the `WRITABLE_GRADEBOOK_URL` setting be properly defined. # TODO: After removing this flag, add a migration to remove waffle flag in a follow-up deployment. WRITABLE_GRADEBOOK = CourseWaffleFlag(f'{WAFFLE_NAMESPACE}.writable_gradebook', __name__, LOG_PREFIX) diff --git a/lms/djangoapps/instructor/toggles.py b/lms/djangoapps/instructor/toggles.py index 5149e8765cf4..556ab7fef4c9 100644 --- a/lms/djangoapps/instructor/toggles.py +++ b/lms/djangoapps/instructor/toggles.py @@ -24,7 +24,7 @@ # .. toggle_description: Supports staged rollout to improved is_small_course method. # .. toggle_use_cases: open_edx # .. toggle_creation_date: 2020-07-02 -# .. toggle_warnings: Description mentions staged rollout, but the use case is not set as temporary. +# .. toggle_warning: Description mentions staged rollout, but the use case is not set as temporary. # This may actually be a temporary toggle. # .. toggle_tickets: PROD-1740 OPTIMISED_IS_SMALL_COURSE = WaffleFlag(f'{WAFFLE_FLAG_NAMESPACE}.optimised_is_small_course', __name__) diff --git a/lms/djangoapps/learner_dashboard/config/waffle.py b/lms/djangoapps/learner_dashboard/config/waffle.py index 32922974b354..af0c8b37384f 100644 --- a/lms/djangoapps/learner_dashboard/config/waffle.py +++ b/lms/djangoapps/learner_dashboard/config/waffle.py @@ -14,7 +14,7 @@ # .. toggle_use_cases: temporary, open_edx # .. toggle_creation_date: 2021-08-25 # .. toggle_target_removal_date: 2021-12-31 -# .. toggle_warnings: When the flag is ON, the new experience for Program discussions will be enabled. +# .. toggle_warning: When the flag is ON, the new experience for Program discussions will be enabled. # .. toggle_tickets: TNL-8434 ENABLE_PROGRAM_TAB_VIEW = WaffleFlag( 'learner_dashboard.enable_program_tab_view', @@ -31,7 +31,7 @@ # .. toggle_use_cases: temporary, open_edx # .. toggle_creation_date: 2021-10-19 # .. toggle_target_removal_date: 2021-12-31 -# .. toggle_warnings: When the flag is ON, the new tabbed experience for Master Program Page will be enabled. +# .. toggle_warning: When the flag is ON, the new tabbed experience for Master Program Page will be enabled. # .. toggle_tickets: TNL-8434 ENABLE_MASTERS_PROGRAM_TAB_VIEW = WaffleFlag( 'learner_dashboard.enable_masters_program_tab_view', diff --git a/lms/djangoapps/teams/toggles.py b/lms/djangoapps/teams/toggles.py index f8cc5ace5525..e853630376aa 100644 --- a/lms/djangoapps/teams/toggles.py +++ b/lms/djangoapps/teams/toggles.py @@ -17,7 +17,7 @@ # .. toggle_creation_date: 2020-03-03 # .. toggle_target_removal_date: None # .. toggle_tickets: https://openedx.atlassian.net/browse/EDUCATOR-4951 -# .. toggle_warnings: This temporary feature toggle does not have a target removal date. This can be overridden by a +# .. toggle_warning: This temporary feature toggle does not have a target removal date. This can be overridden by a # course waffle flags or a waffle switch with identical name. # TODO: this should be moved to edx/edx-ora2 TEAM_SUBMISSIONS_FEATURE = SettingDictToggle( diff --git a/lms/djangoapps/teams/waffle.py b/lms/djangoapps/teams/waffle.py index 3356302b72b6..aeca22d61f24 100644 --- a/lms/djangoapps/teams/waffle.py +++ b/lms/djangoapps/teams/waffle.py @@ -12,7 +12,7 @@ # .. toggle_use_cases: temporary, open_edx # .. toggle_creation_date: 2021-10-07 # .. toggle_target_removal_date: 2021-11-01 -# .. toggle_warnings: When the flag is ON, the teams app will be visible in the new course authoring mfe. +# .. toggle_warning: When the flag is ON, the teams app will be visible in the new course authoring mfe. # .. toggle_tickets: TNL-8816 ENABLE_TEAMS_APP = WaffleFlag( 'teams.enable_teams_app', diff --git a/lms/djangoapps/verify_student/toggles.py b/lms/djangoapps/verify_student/toggles.py index 1632d26a979c..c1bb96365be4 100644 --- a/lms/djangoapps/verify_student/toggles.py +++ b/lms/djangoapps/verify_student/toggles.py @@ -16,7 +16,7 @@ # .. toggle_use_cases: temporary, open_edx # .. toggle_creation_date: 2020-06-25 # .. toggle_target_removal_date: None -# .. toggle_warnings: This temporary feature toggle does not have a target removal date. +# .. toggle_warning: This temporary feature toggle does not have a target removal date. # .. toggle_tickets: PROD-1639 USE_NEW_EMAIL_TEMPLATES = WaffleFlag(f'{WAFFLE_FLAG_NAMESPACE}.use_new_email_templates', __name__) diff --git a/lms/envs/common.py b/lms/envs/common.py index f84e2b958865..bc976d4661a5 100644 --- a/lms/envs/common.py +++ b/lms/envs/common.py @@ -107,7 +107,7 @@ # .. toggle_description: This displays histograms in the Staff Debug Info panel to course staff. # .. toggle_use_cases: open_edx # .. toggle_creation_date: 2014-02-13 - # .. toggle_warnings: Generating histograms requires scanning the courseware_studentmodule table on each view. This + # .. toggle_warning: Generating histograms requires scanning the courseware_studentmodule table on each view. This # can make staff access to courseware very slow on large courses. # .. toggle_tickets: https://github.com/edx/edx-platform/pull/2425 'DISPLAY_HISTOGRAMS_TO_STAFF': False, # For large courses this slows down courseware access for staff. @@ -121,7 +121,7 @@ # date. # .. toggle_use_cases: open_edx # .. toggle_creation_date: 2012-07-24 - # .. toggle_warnings: This will cause ALL courses to be immediately visible. + # .. toggle_warning: This will cause ALL courses to be immediately visible. # .. toggle_tickets: https://github.com/edx/edx-platform/pull/17913 ## DO NOT SET TO True IN THIS FILE ## Doing so will cause all courses to be released on production @@ -134,7 +134,7 @@ # to False will not contain inline discussion components and discussion tab in any courses. # .. toggle_use_cases: open_edx # .. toggle_creation_date: 2012-08-14 - # .. toggle_warnings: If the discussion panel is present in the course and the value for this flag is False then, + # .. toggle_warning: If the discussion panel is present in the course and the value for this flag is False then, # attempting to expand those components will cause errors. So, this should only be set to False with an LMS that # is running courses that do not contain discussion components. # For consistency in user-experience, keep the value in sync with the setting of the same name in the CMS. @@ -146,7 +146,7 @@ # .. toggle_description: Add PDF and HTML textbook tabs to the courseware. # .. toggle_use_cases: open_edx # .. toggle_creation_date: 2014-03-27 - # .. toggle_warnings: For consistency in user-experience, keep the value in sync with the setting of the same name + # .. toggle_warning: For consistency in user-experience, keep the value in sync with the setting of the same name # in the CMS. # .. toggle_tickets: https://github.com/edx/edx-platform/pull/3064 'ENABLE_TEXTBOOK': True, @@ -158,7 +158,7 @@ # on/off setting for discussion digest emails. # .. toggle_use_cases: open_edx # .. toggle_creation_date: 2013-07-30 - # .. toggle_warnings: This should remain off in production until digest notifications are online. + # .. toggle_warning: This should remain off in production until digest notifications are online. # .. toggle_tickets: https://github.com/edx/edx-platform/pull/520 'ENABLE_DISCUSSION_HOME_PANEL': False, @@ -171,7 +171,7 @@ # .. toggle_use_cases: open_edx # .. toggle_creation_date: 2014-08-19 # .. toggle_target_removal_date: None - # .. toggle_warnings: It is not recommended to enable this feature if ENABLE_DISCUSSION_HOME_PANEL is not enabled, + # .. toggle_warning: It is not recommended to enable this feature if ENABLE_DISCUSSION_HOME_PANEL is not enabled, # since subscribers who receive digests in that case will only be able to unsubscribe via links embedded in # their emails, and they will have no way to resubscribe. # .. toggle_tickets: https://github.com/edx/edx-platform/pull/4891 @@ -194,7 +194,7 @@ # .. toggle_description: Set to False if you want to disable Django's admin site. # .. toggle_use_cases: open_edx # .. toggle_creation_date: 2013-09-26 - # .. toggle_warnings: It is not recommended to disable this feature as there are many settings available on + # .. toggle_warning: It is not recommended to disable this feature as there are many settings available on # Django's admin site and will be inaccessible to the superuser. # .. toggle_tickets: https://github.com/edx/edx-platform/pull/829 'ENABLE_DJANGO_ADMIN_SITE': True, @@ -225,7 +225,7 @@ # .. toggle_use_cases: temporary # .. toggle_creation_date: 2014-09-09 # .. toggle_target_removal_date: None - # .. toggle_warnings: This temporary feature toggle does not have a target removal date. + # .. toggle_warning: This temporary feature toggle does not have a target removal date. 'ENABLE_OAUTH2_PROVIDER': False, # .. toggle_name: FEATURES['ENABLE_XBLOCK_VIEW_ENDPOINT'] @@ -251,7 +251,7 @@ # Courses link will be visible. Set to False if courses list and Explore Courses link need to be hidden. # .. toggle_use_cases: open_edx # .. toggle_creation_date: 2013-09-28 - # .. toggle_warnings: This Effects views and templates. + # .. toggle_warning: This Effects views and templates. # .. toggle_tickets: https://github.com/edx/edx-platform/pull/1073 'COURSES_ARE_BROWSABLE': True, @@ -315,7 +315,7 @@ # .. toggle_description: Set to True to enable Custom Courses for edX, a feature that is more commonly known as # CCX. Documentation for configuring and using this feature is available at # https://edx.readthedocs.io/projects/open-edx-ca/en/latest/set_up_course/custom_courses.html - # .. toggle_warnings: When set to true, 'lms.djangoapps.ccx.overrides.CustomCoursesForEdxOverrideProvider' will + # .. toggle_warning: When set to true, 'lms.djangoapps.ccx.overrides.CustomCoursesForEdxOverrideProvider' will # be added to MODULESTORE_FIELD_OVERRIDE_PROVIDERS # .. toggle_use_cases: opt_in, circuit_breaker # .. toggle_creation_date: 2015-04-10 @@ -348,7 +348,7 @@ # can be turned off by enabling this feature flag. # .. toggle_use_cases: open_edx # .. toggle_creation_date: 2013-07-25 - # .. toggle_warnings: If this has been set to True then the account activation email will be skipped. + # .. toggle_warning: If this has been set to True then the account activation email will be skipped. # .. toggle_tickets: https://github.com/edx/edx-platform/pull/417 'AUTOMATIC_AUTH_FOR_TESTING': False, @@ -370,7 +370,7 @@ # .. toggle_description: Enable the login micro frontend. # .. toggle_use_cases: open_edx # .. toggle_creation_date: 2018-05-07 - # .. toggle_warnings: The login MFE domain name should be listed in LOGIN_REDIRECT_WHITELIST. + # .. toggle_warning: The login MFE domain name should be listed in LOGIN_REDIRECT_WHITELIST. 'ENABLE_LOGIN_MICROFRONTEND': False, # .. toggle_name: FEATURES['SKIP_EMAIL_VALIDATION'] @@ -380,7 +380,7 @@ # Beware, as this leaves the door open to potential spam abuse. # .. toggle_use_cases: open_edx # .. toggle_creation_date: 2018-05-07 - # .. toggle_warnings: The login MFE domain name should be listed in LOGIN_REDIRECT_WHITELIST. + # .. toggle_warning: The login MFE domain name should be listed in LOGIN_REDIRECT_WHITELIST. 'SKIP_EMAIL_VALIDATION': False, # .. toggle_name: FEATURES['ENABLE_COSMETIC_DISPLAY_PRICE'] @@ -391,7 +391,7 @@ # .. toggle_use_cases: open_edx # .. toggle_creation_date: 2014-10-10 # .. toggle_tickets: https://github.com/edx/edx-platform/pull/6876 - # .. toggle_warnings: The use case of this feature toggle is uncertain. + # .. toggle_warning: The use case of this feature toggle is uncertain. 'ENABLE_COSMETIC_DISPLAY_PRICE': False, # Automatically approve student identity verification attempts @@ -445,7 +445,7 @@ # .. toggle_use_cases: open_edx # .. toggle_creation_date: 2014-02-27 # .. toggle_target_removal_date: None - # .. toggle_warnings: reverse proxy should be configured appropriately for example Client IP address headers + # .. toggle_warning: reverse proxy should be configured appropriately for example Client IP address headers # (e.g HTTP_X_FORWARDED_FOR) should be configured. # .. toggle_tickets: https://github.com/edx/edx-platform/pull/2749 'EMBARGO': False, @@ -472,7 +472,7 @@ # .. toggle_description: Toggle to enable alternate urls for marketing links. # .. toggle_use_cases: open_edx # .. toggle_creation_date: 2014-03-24 - # .. toggle_warnings: When this is enabled, the MKTG_URLS setting should be defined. The use case of this feature + # .. toggle_warning: When this is enabled, the MKTG_URLS setting should be defined. The use case of this feature # toggle is uncertain. 'ENABLE_MKTG_SITE': False, @@ -536,7 +536,7 @@ # the footer. # .. toggle_use_cases: open_edx # .. toggle_creation_date: 2015-01-13 - # .. toggle_warnings: If you set this to True then you should also set your mobile application's app store and play + # .. toggle_warning: If you set this to True then you should also set your mobile application's app store and play # store URLs in the MOBILE_STORE_URLS settings dictionary. These links are not part of the default theme. If you # want these links on your footer then you should use the edx.org theme. # .. toggle_tickets: https://github.com/edx/edx-platform/pull/6588 @@ -549,7 +549,7 @@ # .. toggle_description: This toggle enables the students to save and manage their annotations in the # course using the notes service. The bulk of the actual work in storing the notes is done by # a separate service (see the edx-notes-api repo). - # .. toggle_warnings: Requires the edx-notes-api service properly running and to have configured the django settings + # .. toggle_warning: Requires the edx-notes-api service properly running and to have configured the django settings # EDXNOTES_INTERNAL_API and EDXNOTES_PUBLIC_API. If you update this setting, also update it in Studio. # .. toggle_use_cases: open_edx # .. toggle_creation_date: 2015-01-04 @@ -580,7 +580,7 @@ # pages for searching courseware data. # .. toggle_use_cases: open_edx # .. toggle_creation_date: 2015-01-29 - # .. toggle_warnings: In order to get this working, your courses data should be indexed in Elasticsearch. You will + # .. toggle_warning: In order to get this working, your courses data should be indexed in Elasticsearch. You will # see the search widget on the courseware page only if the DISABLE_COURSE_OUTLINE_PAGE_FLAG is set. # .. toggle_tickets: https://github.com/edx/edx-platform/pull/6506 'ENABLE_COURSEWARE_SEARCH': False, @@ -592,7 +592,7 @@ # pages for searching courseware data but for course staff users only. # .. toggle_use_cases: open_edx # .. toggle_creation_date: 2019-12-06 - # .. toggle_warnings: In order to get this working, your courses data should be indexed in Elasticsearch. If + # .. toggle_warning: In order to get this working, your courses data should be indexed in Elasticsearch. If # ENABLE_COURSEWARE_SEARCH is enabled then the search widget will be visible to all learners and this flag's # value does not matter in that case. This flag is enabled in devstack by default. # .. toggle_tickets: https://openedx.atlassian.net/browse/TNL-6931 @@ -606,7 +606,7 @@ # courseware data. # .. toggle_use_cases: open_edx # .. toggle_creation_date: 2015-01-29 - # .. toggle_warnings: In order to get this working, your courses data should be indexed in Elasticsearch. + # .. toggle_warning: In order to get this working, your courses data should be indexed in Elasticsearch. # .. toggle_tickets: https://github.com/edx/edx-platform/pull/6506 'ENABLE_DASHBOARD_SEARCH': False, @@ -627,7 +627,7 @@ # .. toggle_implementation: DjangoSetting # .. toggle_default: False # .. toggle_description: Set to True to enable course certificates on your instance of Open edX. - # .. toggle_warnings: You must enable this feature flag in both Studio and the LMS and complete the configuration tasks + # .. toggle_warning: You must enable this feature flag in both Studio and the LMS and complete the configuration tasks # described here: # https://edx.readthedocs.io/projects/edx-installing-configuring-and-running/en/latest/configuration/enable_certificates.html pylint: disable=line-too-long,useless-suppression # .. toggle_use_cases: open_edx @@ -640,7 +640,7 @@ # .. toggle_implementation: DjangoSetting # .. toggle_default: False # .. toggle_description: Set to True to enable custom certificate templates which are configured via Django admin. - # .. toggle_warnings: None + # .. toggle_warning: None # .. toggle_use_cases: open_edx # .. toggle_creation_date: 2015-08-13 # .. toggle_target_removal_date: None @@ -656,7 +656,7 @@ # .. toggle_use_cases: open_edx # .. toggle_creation_date: 2015-04-23 # .. toggle_target_removal_date: None - # .. toggle_warnings: The COURSE_DISCOVERY_MEANINGS setting should be properly defined. + # .. toggle_warning: The COURSE_DISCOVERY_MEANINGS setting should be properly defined. # .. toggle_tickets: https://github.com/edx/edx-platform/pull/7845 'ENABLE_COURSE_DISCOVERY': False, @@ -668,7 +668,7 @@ # .. toggle_creation_date: 2021-03-16 # .. toggle_target_removal_date: None # .. toggle_tickets: None - # .. toggle_warnings: Turning this feature ON will affect all generated filenames which are related to CCX courses. + # .. toggle_warning: Turning this feature ON will affect all generated filenames which are related to CCX courses. 'ENABLE_COURSE_FILENAME_CCX_SUFFIX': False, # Setting for overriding default filtering facets for Course discovery @@ -699,7 +699,7 @@ # .. toggle_implementation: DjangoSetting # .. toggle_default: False # .. toggle_description: Enables support for the creation of OpenBadges as a method of awarding credentials. - # .. toggle_warnings: The following settings (all of which are in the same file) should be set or reviewed prior to + # .. toggle_warning: The following settings (all of which are in the same file) should be set or reviewed prior to # enabling this setting: BADGING_BACKEND, BADGR_API_TOKEN, BADGR_BASE_URL, BADGR_ISSUER_SLUG, BADGR_TIMEOUT. # Full guide for setting up OpenBadges available here: # https://edx.readthedocs.io/projects/edx-installing-configuring-and-running/en/latest/configuration/enable_badging.html pylint: disable=line-too-long,useless-suppression @@ -713,7 +713,7 @@ # .. toggle_default: False # .. toggle_description: When set to True, Open edX site can be used as an LTI Provider to other systems # and applications. - # .. toggle_warnings: After enabling this feature flag there are multiple steps invloved to configure edX + # .. toggle_warning: After enabling this feature flag there are multiple steps invloved to configure edX # as LTI provider. Full guide is available here: # https://edx.readthedocs.io/projects/edx-installing-configuring-and-running/en/latest/configuration/lti/index.html # .. toggle_use_cases: open_edx @@ -727,7 +727,7 @@ # .. toggle_description: When set to True, language selector will be visible in the header. # .. toggle_use_cases: open_edx # .. toggle_creation_date: 2017-05-25 - # .. toggle_warnings: You should set the languages in the DarkLangConfig table to get this working. If you have + # .. toggle_warning: You should set the languages in the DarkLangConfig table to get this working. If you have # not set any languages in the DarkLangConfig table then the language selector will not be visible in the header. # .. toggle_tickets: https://github.com/edx/edx-platform/pull/15133 'SHOW_HEADER_LANGUAGE_SELECTOR': False, @@ -743,7 +743,7 @@ # .. toggle_description: When set to True, language selector will be visible in the footer. # .. toggle_use_cases: open_edx # .. toggle_creation_date: 2017-05-25 - # .. toggle_warnings: LANGUAGE_COOKIE_NAME is required to use footer-language-selector, set it if it has not been set. + # .. toggle_warning: LANGUAGE_COOKIE_NAME is required to use footer-language-selector, set it if it has not been set. # .. toggle_tickets: https://github.com/edx/edx-platform/pull/15133 'SHOW_FOOTER_LANGUAGE_SELECTOR': False, @@ -754,7 +754,7 @@ # student activities to MySQL, in a separate database. # .. toggle_use_cases: open_edx # .. toggle_creation_date: 2020-11-05 - # .. toggle_warnings: Even though most Open edX instances run with a separate CSMH database, it may not always be + # .. toggle_warning: Even though most Open edX instances run with a separate CSMH database, it may not always be # the case. When disabling this feature flag, remember to remove "lms.djangoapps.coursewarehistoryextended" # from the INSTALLED_APPS and the "StudentModuleHistoryExtendedRouter" from the DATABASE_ROUTERS. 'ENABLE_CSMH_EXTENDED': True, @@ -823,7 +823,7 @@ # .. toggle_default: False # .. toggle_description: Whether HTML Block returns HTML content with the Course Blocks API when the API # is called with student_view_data=html query parameter. - # .. toggle_warnings: Because the Course Blocks API caches its data, the cache must be cleared (e.g. by + # .. toggle_warning: Because the Course Blocks API caches its data, the cache must be cleared (e.g. by # re-publishing the course) for changes to this flag to take effect. # .. toggle_use_cases: open_edx # .. toggle_creation_date: 2017-08-28 @@ -877,7 +877,7 @@ # .. toggle_creation_date: 2020-09-08 # .. toggle_target_removal_date: None # .. toggle_tickets: 'https://github.com/edx/edx-platform/pull/24908' - # .. toggle_warnings: Also set settings.AUTHN_MICROFRONTEND_URL for rollout. This temporary feature + # .. toggle_warning: Also set settings.AUTHN_MICROFRONTEND_URL for rollout. This temporary feature # toggle does not have a target removal date. 'ENABLE_AUTHN_MICROFRONTEND': os.environ.get("EDXAPP_ENABLE_AUTHN_MFE", False), @@ -892,7 +892,7 @@ # .. toggle_creation_date: 2020-03-03 # .. toggle_target_removal_date: None # .. toggle_tickets: https://openedx.atlassian.net/browse/EDUCATOR-4951 - # .. toggle_warnings: This temporary feature toggle does not have a target removal date. + # .. toggle_warning: This temporary feature toggle does not have a target removal date. 'ENABLE_ORA_ALL_FILE_URLS': False, # .. toggle_name: FEATURES['ENABLE_ORA_USER_STATE_UPLOAD_DATA'] @@ -904,7 +904,7 @@ # .. toggle_creation_date: 2020-03-03 # .. toggle_target_removal_date: None # .. toggle_tickets: https://openedx.atlassian.net/browse/EDUCATOR-4951 - # .. toggle_warnings: This temporary feature toggle does not have a target removal date. + # .. toggle_warning: This temporary feature toggle does not have a target removal date. 'ENABLE_ORA_USER_STATE_UPLOAD_DATA': False, # .. toggle_name: FEATURES['ENABLE_ORA_USERNAMES_ON_DATA_EXPORT'] @@ -916,7 +916,7 @@ # .. toggle_creation_date: 2020-06-11 # .. toggle_target_removal_date: None # .. toggle_tickets: https://openedx.atlassian.net/browse/TNL-7273 - # .. toggle_warnings: This temporary feature toggle does not have a target removal date. + # .. toggle_warning: This temporary feature toggle does not have a target removal date. 'ENABLE_ORA_USERNAMES_ON_DATA_EXPORT': False, # .. toggle_name: FEATURES['ENABLE_COURSE_ASSESSMENT_GRADE_CHANGE_SIGNAL'] @@ -947,7 +947,7 @@ # .. toggle_use_cases: open_edx # .. toggle_creation_date: 2021-03-11 # .. toggle_target_removal_date: None - # .. toggle_warnings: None + # .. toggle_warning: None # .. toggle_tickets: 'https://openedx.atlassian.net/browse/OSPR-5290' 'ENABLE_BULK_USER_RETIREMENT': False, @@ -994,7 +994,7 @@ # .. toggle_creation_date: 2022-03-22 # .. toggle_target_removal_date: None # .. toggle_tickets: https://github.com/edx/edx-platform/pull/28268 - # .. toggle_warnings: For consistency in user-experience, keep the value in sync with the setting of the same name + # .. toggle_warning: For consistency in user-experience, keep the value in sync with the setting of the same name # in the LMS and CMS. 'MARK_LIBRARY_CONTENT_BLOCK_COMPLETE_ON_VIEW': False, @@ -1005,7 +1005,7 @@ # This also hides the "Unenroll" button on the Learner Dashboard. # .. toggle_use_cases: open_edx # .. toggle_creation_date: 2021-10-11 - # .. toggle_warnings: For consistency in user experience, keep the value in sync with the setting of the same name + # .. toggle_warning: For consistency in user experience, keep the value in sync with the setting of the same name # in the LMS and CMS. # .. toggle_tickets: 'https://github.com/open-craft/edx-platform/pull/429' 'DISABLE_UNENROLLMENT': False, @@ -1978,7 +1978,7 @@ def _make_locale_paths(settings): # pylint: disable=missing-function-docstring # .. toggle_description: Enabling this allows access to anonymous users. # For the original docs, see: # https://github.com/edx/django-wiki/blob/edx_release/wiki/conf/settings.py -# .. toggle_warnings: Setting allow anonymous access to `True` may have styling issues. +# .. toggle_warning: Setting allow anonymous access to `True` may have styling issues. # .. toggle_use_cases: open_edx # .. toggle_creation_date: 2012-08-21 WIKI_ANONYMOUS = False @@ -2854,7 +2854,7 @@ def _make_locale_paths(settings): # pylint: disable=missing-function-docstring # files are kept for each structure, and the rest are cleaned up. The number of versions that # are kept can be specified in the `BlockStructureConfiguration`, which can be edited in # Django Admin. The default number of versions that are kept is `5`. - # .. toggle_warnings: This toggle will likely be deprecated and removed. + # .. toggle_warning: This toggle will likely be deprecated and removed. # .. toggle_use_cases: temporary # .. toggle_creation_date: 2018-03-22 # .. toggle_target_removal_date: 2018-06-22 @@ -3638,7 +3638,7 @@ def _make_locale_paths(settings): # pylint: disable=missing-function-docstring # learners will be notified by email when they earn a badge. # .. toggle_use_cases: open_edx # .. toggle_creation_date: 2021-07-29 -# .. toggle_warnings: Review FEATURES['ENABLE_OPENBADGES'] for further context. +# .. toggle_warning: Review FEATURES['ENABLE_OPENBADGES'] for further context. BADGR_ENABLE_NOTIFICATIONS = False ###################### Grade Downloads ###################### diff --git a/openedx/core/djangoapps/content/block_structure/config/__init__.py b/openedx/core/djangoapps/content/block_structure/config/__init__.py index a0fa0ad6b133..19956ff07331 100644 --- a/openedx/core/djangoapps/content/block_structure/config/__init__.py +++ b/openedx/core/djangoapps/content/block_structure/config/__init__.py @@ -16,7 +16,7 @@ # .. toggle_description: When enabled, the block structure cache is invalidated when changes to # courses are published. If `block_structure.storage_backing_for_cache` is active, all block # structures related to the published course are also cleared from storage. -# .. toggle_warnings: This switch will likely be deprecated and removed. +# .. toggle_warning: This switch will likely be deprecated and removed. # .. toggle_use_cases: temporary # .. toggle_creation_date: 2017-02-23 # .. toggle_target_removal_date: 2017-05-23 @@ -34,7 +34,7 @@ # like a database, which provides an additional backup for cache misses, instead having them # regenerated. The regenration of block structures is a time consuming process. Therefore, # enabling this switch is recommended for Production. -# .. toggle_warnings: Depends on `BLOCK_STRUCTURES_SETTINGS['STORAGE_CLASS']` and +# .. toggle_warning: Depends on `BLOCK_STRUCTURES_SETTINGS['STORAGE_CLASS']` and # `BLOCK_STRUCTURES_SETTINGS['STORAGE_KWARGS']`. # This switch will likely be deprecated and removed. # The annotation will be updated with the DEPR ticket once that process has started. @@ -54,7 +54,7 @@ # .. toggle_description: Raises an error if the requested block structure does not exist in block # structure store, or if it is outdated. Block structure store refers to both cache and storage, # if enabled. -# .. toggle_warnings: This switch will likely be deprecated and removed. +# .. toggle_warning: This switch will likely be deprecated and removed. # The annotation will be updated with the DEPR ticket once that process has started. # .. toggle_use_cases: temporary # .. toggle_creation_date: 2017-02-23 diff --git a/openedx/core/djangoapps/cookie_metadata/middleware.py b/openedx/core/djangoapps/cookie_metadata/middleware.py index 4435c4866dff..f54839da8fe8 100644 --- a/openedx/core/djangoapps/cookie_metadata/middleware.py +++ b/openedx/core/djangoapps/cookie_metadata/middleware.py @@ -61,7 +61,7 @@ def __call__(self, request): # .. toggle_implementation: DjangoSetting # .. toggle_default: False # .. toggle_description: Used to enable CookieNameChange middleware which changes a cookie name in request.COOKIES - # .. toggle_warnings: This should be set at the same time you set COOKIE_NAME_CHANGE_EXPAND_INFO setting + # .. toggle_warning: This should be set at the same time you set COOKIE_NAME_CHANGE_EXPAND_INFO setting # .. toggle_use_cases: temporary # .. toggle_creation_date: 2021-08-04 # .. toggle_target_removal_date: 2021-10-01 diff --git a/openedx/core/djangoapps/course_apps/toggles.py b/openedx/core/djangoapps/course_apps/toggles.py index b85d2e55a362..c9bd16a15734 100644 --- a/openedx/core/djangoapps/course_apps/toggles.py +++ b/openedx/core/djangoapps/course_apps/toggles.py @@ -12,7 +12,7 @@ # .. toggle_default: False # .. toggle_description: When enabled, users will be directed to a new proctoring settings # modal on the Pages and Resources view when accessing proctored exam settings. -# .. toggle_warnings: None +# .. toggle_warning: None # .. toggle_creation_date: 2021-08-17 # .. toggle_target_removal_date: None PROCTORING_SETTINGS_MODAL_VIEW = CourseWaffleFlag( diff --git a/openedx/core/djangoapps/course_live/config/waffle.py b/openedx/core/djangoapps/course_live/config/waffle.py index 098201fb358c..f86a368bc01d 100644 --- a/openedx/core/djangoapps/course_live/config/waffle.py +++ b/openedx/core/djangoapps/course_live/config/waffle.py @@ -14,6 +14,6 @@ # .. toggle_use_cases: temporary, open_edx # .. toggle_creation_date: 2022-03-02 # .. toggle_target_removal_date: 2022-06-02 -# .. toggle_warnings: When the flag is ON, the course live app will be visible in the course authoring mfe +# .. toggle_warning: When the flag is ON, the course live app will be visible in the course authoring mfe # .. toggle_tickets: TNL-9603 ENABLE_COURSE_LIVE = CourseWaffleFlag(f'{WAFFLE_NAMESPACE}.enable_course_live', __name__) diff --git a/openedx/core/djangoapps/credentials/helpers.py b/openedx/core/djangoapps/credentials/helpers.py index 58b56747eae5..b654a8cb921a 100644 --- a/openedx/core/djangoapps/credentials/helpers.py +++ b/openedx/core/djangoapps/credentials/helpers.py @@ -11,7 +11,7 @@ # .. toggle_default: True # .. toggle_description: Enable learner records for the whole platform. This setting may be overridden by site- and # org-specific site configurations with the same name. -# .. toggle_warnings: Enabling this feature requires that the definition of the ``CREDENTIALS_PUBLIC_SERVICE_URL`` +# .. toggle_warning: Enabling this feature requires that the definition of the ``CREDENTIALS_PUBLIC_SERVICE_URL`` # setting. # .. toggle_use_cases: open_edx # .. toggle_creation_date: 2020-10-01 diff --git a/openedx/core/djangoapps/discussions/config/waffle.py b/openedx/core/djangoapps/discussions/config/waffle.py index 6d56e48b9947..091839c7f337 100644 --- a/openedx/core/djangoapps/discussions/config/waffle.py +++ b/openedx/core/djangoapps/discussions/config/waffle.py @@ -15,7 +15,7 @@ # .. toggle_use_cases: temporary, open_edx # .. toggle_creation_date: 2021-06-15 # .. toggle_target_removal_date: 2021-12-31 -# .. toggle_warnings: When the flag is ON, the discussion settings will be available on legacy experience. +# .. toggle_warning: When the flag is ON, the discussion settings will be available on legacy experience. # .. toggle_tickets: TNL-8389 OVERRIDE_DISCUSSION_LEGACY_SETTINGS_FLAG = CourseWaffleFlag( f'{WAFFLE_NAMESPACE}.override_discussion_legacy_settings', __name__ @@ -29,7 +29,7 @@ # .. toggle_use_cases: temporary, open_edx # .. toggle_creation_date: 2021-05-24 # .. toggle_target_removal_date: 2021-12-31 -# .. toggle_warnings: When the flag is ON, the new experience for Pages and Resources will be enabled. +# .. toggle_warning: When the flag is ON, the new experience for Pages and Resources will be enabled. # .. toggle_tickets: TNL-7791 ENABLE_PAGES_AND_RESOURCES_MICROFRONTEND = CourseWaffleFlag( f'{WAFFLE_NAMESPACE}.pages_and_resources_mfe', __name__ diff --git a/openedx/core/djangoapps/safe_sessions/middleware.py b/openedx/core/djangoapps/safe_sessions/middleware.py index 6892da757737..e5b36000a4cf 100644 --- a/openedx/core/djangoapps/safe_sessions/middleware.py +++ b/openedx/core/djangoapps/safe_sessions/middleware.py @@ -106,7 +106,7 @@ # information on the request. This will also track the location where the change is coming from to quickly find # issues. If user verification fails at response time, all of the information about these # changes will be logged. -# .. toggle_warnings: Adds some processing overhead to all requests to gather debug info. Will also double the logging +# .. toggle_warning: Adds some processing overhead to all requests to gather debug info. Will also double the logging # for failed verification checks. # .. toggle_use_cases: opt_in # .. toggle_creation_date: 2021-03-25 @@ -120,7 +120,7 @@ # any user id change detected by safe sessions. The headers will provide additional debugging information. The # headers will be logged for all requests up until LOG_REQUEST_USER_CHANGE_HEADERS_DURATION seconds after # the time of the last mismatch. The header details will be encrypted, and only available with the private key. -# .. toggle_warnings: Logging headers of subsequent requests following a mismatch will only work if +# .. toggle_warning: Logging headers of subsequent requests following a mismatch will only work if # LOG_REQUEST_USER_CHANGES is enabled and ENFORCE_SAFE_SESSIONS is disabled; otherwise, only headers of the inital # mismatch will be logged. Also, SAFE_SESSIONS_DEBUG_PUBLIC_KEY must be set. See # https://github.com/edx/edx-platform/blob/master/common/djangoapps/util/log_sensitive.py @@ -142,7 +142,7 @@ # response cancelled (changed to an error). This is intended as a backup # safety measure in case an attacker (or bug) is able to change the user # on a session in an unexpected way. -# .. toggle_warnings: Should be disabled if debugging mismatches using the +# .. toggle_warning: Should be disabled if debugging mismatches using the # LOG_REQUEST_USER_CHANGE_HEADERS toggle, otherwise series of mismatching # requests from the same user cannot be investigated. Additionally, if # enabling for the first time, confirm that incidences of the string diff --git a/openedx/core/djangoapps/user_api/accounts/toggles.py b/openedx/core/djangoapps/user_api/accounts/toggles.py index d21eeb96aafe..80de4fa75692 100644 --- a/openedx/core/djangoapps/user_api/accounts/toggles.py +++ b/openedx/core/djangoapps/user_api/accounts/toggles.py @@ -13,7 +13,7 @@ # .. toggle_use_cases: temporary, open_edx # .. toggle_creation_date: 2019-04-11 # .. toggle_target_removal_date: 2020-12-31 -# .. toggle_warnings: Also set settings.ORDER_HISTORY_MICROFRONTEND_URL and site's +# .. toggle_warning: Also set settings.ORDER_HISTORY_MICROFRONTEND_URL and site's # ENABLE_ORDER_HISTORY_MICROFRONTEND. # .. toggle_tickets: DEPR-17 REDIRECT_TO_ORDER_HISTORY_MICROFRONTEND = WaffleFlag('order_history.redirect_to_microfrontend', __name__) @@ -34,7 +34,7 @@ def should_redirect_to_order_history_microfrontend(): # .. toggle_use_cases: temporary, open_edx # .. toggle_creation_date: 2019-04-30 # .. toggle_target_removal_date: 2021-12-31 -# .. toggle_warnings: Also set settings.ACCOUNT_MICROFRONTEND_URL. +# .. toggle_warning: Also set settings.ACCOUNT_MICROFRONTEND_URL. # .. toggle_tickets: DEPR-17 REDIRECT_TO_ACCOUNT_MICROFRONTEND = WaffleFlag('account.redirect_to_microfrontend', __name__) diff --git a/openedx/core/djangoapps/user_authn/config/waffle.py b/openedx/core/djangoapps/user_authn/config/waffle.py index 1183d943199e..c34c81e1d063 100644 --- a/openedx/core/djangoapps/user_authn/config/waffle.py +++ b/openedx/core/djangoapps/user_authn/config/waffle.py @@ -15,7 +15,7 @@ # .. toggle_use_cases: temporary # .. toggle_creation_date: 2019-11-20 # .. toggle_target_removal_date: 2020-01-31 -# .. toggle_warnings: Requires THIRD_PARTY_AUTH_ONLY_DOMAIN to also be set. +# .. toggle_warning: Requires THIRD_PARTY_AUTH_ONLY_DOMAIN to also be set. # .. toggle_tickets: ENT-2461 ENABLE_LOGIN_USING_THIRDPARTY_AUTH_ONLY = WaffleSwitch( f'{_WAFFLE_NAMESPACE}.enable_login_using_thirdparty_auth_only', __name__ diff --git a/openedx/core/djangoapps/user_authn/toggles.py b/openedx/core/djangoapps/user_authn/toggles.py index 8073a6acfc6e..38d9dbae4016 100644 --- a/openedx/core/djangoapps/user_authn/toggles.py +++ b/openedx/core/djangoapps/user_authn/toggles.py @@ -15,7 +15,7 @@ # authentication with third party auth # .. toggle_use_cases: open_edx # .. toggle_creation_date: 2020-09-16 -# .. toggle_warnings: Requires configuration of third party auth +# .. toggle_warning: Requires configuration of third party auth def is_require_third_party_auth_enabled(): diff --git a/openedx/core/djangoapps/user_authn/views/register.py b/openedx/core/djangoapps/user_authn/views/register.py index 6310ce2c020e..6802705f9054 100644 --- a/openedx/core/djangoapps/user_authn/views/register.py +++ b/openedx/core/djangoapps/user_authn/views/register.py @@ -114,7 +114,7 @@ # .. 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_warning: This temporary feature toggle does not have a target removal date. REGISTRATION_FAILURE_LOGGING_FLAG = WaffleFlag('registration.enable_failure_logging', __name__) REAL_IP_KEY = 'openedx.core.djangoapps.util.ratelimit.real_ip' diff --git a/openedx/core/djangoapps/video_pipeline/config/waffle.py b/openedx/core/djangoapps/video_pipeline/config/waffle.py index 5964cdfa5e9b..15c4933797f5 100644 --- a/openedx/core/djangoapps/video_pipeline/config/waffle.py +++ b/openedx/core/djangoapps/video_pipeline/config/waffle.py @@ -29,7 +29,7 @@ # of enabling this feature toggle are uncertain.] # .. toggle_use_cases: open_edx # .. toggle_creation_date: 2020-03-12 -# .. toggle_warnings: Enabling this feature requires that the ROLE_ARN, MFA_SERIAL_NUMBER, MFA_TOKEN settings are +# .. toggle_warning: 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 ENABLE_DEVSTACK_VIDEO_UPLOADS = WaffleFlag(f'{WAFFLE_NAMESPACE}.enable_devstack_video_uploads', __name__, LOG_PREFIX) diff --git a/openedx/core/lib/blockstore_api/config/waffle.py b/openedx/core/lib/blockstore_api/config/waffle.py index ebbacb7f599d..192d4d5c3ab2 100644 --- a/openedx/core/lib/blockstore_api/config/waffle.py +++ b/openedx/core/lib/blockstore_api/config/waffle.py @@ -14,7 +14,7 @@ # .. toggle_creation_date: 2022-01-13 # .. toggle_target_removal_date: None # .. toggle_tickets: TNL-8705, BD-14 -# .. toggle_warnings: This temporary feature toggle does not have a target removal date. +# .. toggle_warning: This temporary feature toggle does not have a target removal date. BLOCKSTORE_USE_BLOCKSTORE_APP_API = WaffleSwitch( 'blockstore.use_blockstore_app_api', __name__ ) diff --git a/openedx/core/lib/request_utils.py b/openedx/core/lib/request_utils.py index 6a6bb39f6e73..e113c550c421 100644 --- a/openedx/core/lib/request_utils.py +++ b/openedx/core/lib/request_utils.py @@ -174,7 +174,7 @@ def process_exception(self, request, exception): # .. toggle_implementation: DjangoSetting # .. toggle_default: False # .. toggle_description: If True, the stacktrace will be included with the logging message. -# .. toggle_warnings: Requires ``LOG_ERROR`` to be set to True, otherwise this value will be ignored. +# .. toggle_warning: Requires ``LOG_ERROR`` to be set to True, otherwise this value will be ignored. # .. toggle_use_cases: opt_in # .. toggle_creation_date: 2021-03-11 diff --git a/openedx/features/announcements/settings/common.py b/openedx/features/announcements/settings/common.py index 1683dc1a3c1e..11a075fb5e9e 100644 --- a/openedx/features/announcements/settings/common.py +++ b/openedx/features/announcements/settings/common.py @@ -11,7 +11,7 @@ def plugin_settings(settings): on the sidebar of the learner dashboard. Announcements can be created by Global Staff users on maintenance dashboard of studio. Maintenance dashboard can accessed at https://{studio.domain}/maintenance - .. toggle_warnings: TinyMCE is needed to show an editor in the studio. + .. toggle_warning: TinyMCE is needed to show an editor in the studio. .. toggle_use_cases: open_edx .. toggle_creation_date: 2017-11-08 .. toggle_tickets: https://github.com/edx/edx-platform/pull/16496 diff --git a/openedx/features/course_experience/__init__.py b/openedx/features/course_experience/__init__.py index f6987f9816fc..e8c0e6ac647b 100644 --- a/openedx/features/course_experience/__init__.py +++ b/openedx/features/course_experience/__init__.py @@ -34,7 +34,7 @@ # .. toggle_use_cases: opt_out, temporary # .. toggle_creation_date: 2017-09-11 # .. toggle_target_removal_date: None -# .. toggle_warnings: This temporary feature toggle does not have a target removal date. +# .. toggle_warning: This temporary feature toggle does not have a target removal date. ENABLE_COURSE_GOALS = CourseWaffleFlag(f'{WAFFLE_FLAG_NAMESPACE}.enable_course_goals', __name__) # lint-amnesty, pylint: disable=toggle-missing-annotation # Waffle flag to enable anonymous access to a course @@ -50,7 +50,7 @@ # course view showing key course dates. Was previously an ExperimentWaffleFlag with experiment_id=17. # .. toggle_use_cases: opt_in # .. toggle_creation_date: 2020-02-10 -# .. toggle_warnings: To set a relative due date for self-paced courses, the weeks_to_complete field for a course run +# .. toggle_warning: To set a relative due date for self-paced courses, the weeks_to_complete field for a course run # needs to be set. Currently it can be set through the publisher app. # .. toggle_tickets: https://openedx.atlassian.net/browse/AA-27 RELATIVE_DATES_FLAG = CourseWaffleFlag(f'{WAFFLE_FLAG_NAMESPACE}.relative_dates', __name__) # lint-amnesty, pylint: disable=toggle-missing-annotation @@ -62,7 +62,7 @@ # that sends course assignment calendars to course students, whenever they click on the "Subscribe to calendar # updates" button. The email contains an ics attachment that students can then use to sync with their own calendar # apps. -# .. toggle_warnings: For this toggle to have an effect, the RELATIVE_DATES_FLAG toggle must be enabled, too. +# .. toggle_warning: For this toggle to have an effect, the RELATIVE_DATES_FLAG toggle must be enabled, too. # .. toggle_use_cases: temporary # .. toggle_creation_date: 2021-01-26 # .. toggle_target_removal_date: 2021-04-26 diff --git a/openedx/features/discounts/applicability.py b/openedx/features/discounts/applicability.py index f4fd4733cbc6..1bb895f7f90f 100644 --- a/openedx/features/discounts/applicability.py +++ b/openedx/features/discounts/applicability.py @@ -36,7 +36,7 @@ # .. toggle_creation_date: 2019-4-16 # .. toggle_target_removal_date: None # .. toggle_tickets: REVEM-282 -# .. toggle_warnings: This temporary feature toggle does not have a target removal date. +# .. toggle_warning: This temporary feature toggle does not have a target removal date. DISCOUNT_APPLICABILITY_FLAG = WaffleFlag('discounts.enable_discounting', __name__) DISCOUNT_APPLICABILITY_HOLDBACK = 'first_purchase_discount_holdback' diff --git a/openedx/features/learner_profile/toggles.py b/openedx/features/learner_profile/toggles.py index 6b29f922ac8c..08378b6e9042 100644 --- a/openedx/features/learner_profile/toggles.py +++ b/openedx/features/learner_profile/toggles.py @@ -17,7 +17,7 @@ # .. toggle_use_cases: temporary, open_edx # .. toggle_creation_date: 2019-02-19 # .. toggle_target_removal_date: 2020-12-31 -# .. toggle_warnings: Also set settings.PROFILE_MICROFRONTEND_URL and site's ENABLE_PROFILE_MICROFRONTEND. +# .. toggle_warning: Also set settings.PROFILE_MICROFRONTEND_URL and site's ENABLE_PROFILE_MICROFRONTEND. # .. toggle_tickets: DEPR-17 REDIRECT_TO_PROFILE_MICROFRONTEND = WaffleFlag(f'{WAFFLE_FLAG_NAMESPACE}.redirect_to_microfrontend', __name__)