From 7c6c166e73d48899907793df3a47a7852efebcf3 Mon Sep 17 00:00:00 2001 From: Stu Young Date: Fri, 27 Sep 2019 11:45:40 -0400 Subject: [PATCH] fix toggle implementation annotations (#21802) fix toggle implementation annotations and rename waffle flags --- lms/djangoapps/bulk_email/models.py | 2 +- lms/djangoapps/experiments/utils.py | 4 ++-- lms/envs/common.py | 6 +++--- openedx/core/djangoapps/user_api/accounts/toggles.py | 8 ++++---- openedx/features/learner_profile/toggles.py | 4 ++-- 5 files changed, 12 insertions(+), 12 deletions(-) diff --git a/lms/djangoapps/bulk_email/models.py b/lms/djangoapps/bulk_email/models.py index 85a3e380ce..51252ac092 100644 --- a/lms/djangoapps/bulk_email/models.py +++ b/lms/djangoapps/bulk_email/models.py @@ -469,7 +469,7 @@ class CourseAuthorization(models.Model): # .. toggle_name: require_course_email_auth -# .. toggle_type: configuration_model +# .. 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. diff --git a/lms/djangoapps/experiments/utils.py b/lms/djangoapps/experiments/utils.py index 4026ec9b97..ade46534d4 100644 --- a/lms/djangoapps/experiments/utils.py +++ b/lms/djangoapps/experiments/utils.py @@ -35,7 +35,7 @@ logger = logging.getLogger(__name__) experiments_namespace = WaffleFlagNamespace(name=u'experiments') # .. toggle_name: experiments.add_programs -# .. toggle_type: waffle_flag +# .. toggle_implementation: WaffleFlag # .. toggle_default: False # .. toggle_description: Toggle for adding the current course's program information to user metadata # .. toggle_category: experiments @@ -52,7 +52,7 @@ PROGRAM_INFO_FLAG = WaffleFlag( ) # .. toggle_name: experiments.add_dashboard_info -# .. toggle_type: waffle_flag +# .. toggle_implementation: WaffleFlag # .. toggle_default: False # .. toggle_description: Toggle for adding info about each course to the dashboard metadata # .. toggle_category: experiments diff --git a/lms/envs/common.py b/lms/envs/common.py index c912453cdf..28d3d37fc0 100644 --- a/lms/envs/common.py +++ b/lms/envs/common.py @@ -98,7 +98,7 @@ FEATURES = { 'ENABLE_TEXTBOOK': True, # .. toggle_name: ENABLE_STUDENT_NOTES - # .. toggle_type: waffle_flag + # .. toggle_implementation: DjangoSetting # .. toggle_default: True # .. toggle_description: Enables the Student Notes API and UI. # .. toggle_category: ???? @@ -128,7 +128,7 @@ FEATURES = { 'ENABLE_MASQUERADE': True, # allow course staff to change to student view of courseware # .. toggle_name: ENABLE_SYSADMIN_DASHBOARD - # .. toggle_type: waffle_flag + # .. toggle_implementation: DjangoSetting # .. toggle_default: False # .. toggle_description: enables dashboard at /syadmin/ for django staff, for seeing overview of system status, for deleting and loading courses, for seeing log of git imports of courseware. # .. toggle_category: admin @@ -193,7 +193,7 @@ FEATURES = { 'ENABLE_VERIFIED_CERTIFICATES': False, # .. toggle_name: DISABLE_HONOR_CERTIFICATES - # .. toggle_type: waffle_flag + # .. toggle_implementation: DjangoSetting # .. toggle_default: False # .. toggle_description: Set to True to disable honor certificates. Typically used when your installation only allows verified certificates, like courses.edx.org. # .. toggle_category: certificates diff --git a/openedx/core/djangoapps/user_api/accounts/toggles.py b/openedx/core/djangoapps/user_api/accounts/toggles.py index 6d2d7a3120..2607bea0dd 100644 --- a/openedx/core/djangoapps/user_api/accounts/toggles.py +++ b/openedx/core/djangoapps/user_api/accounts/toggles.py @@ -6,8 +6,8 @@ from __future__ import absolute_import from openedx.core.djangoapps.site_configuration import helpers as configuration_helpers from openedx.core.djangoapps.waffle_utils import WaffleFlag -# .. toggle_name: REDIRECT_TO_ORDER_HISTORY_MICROFRONTEND -# .. toggle_type: waffle_flag +# .. toggle_name: order_history.redirect_to_microfrontend +# .. toggle_implementation: WaffleFlag # .. toggle_default: False # .. toggle_description: Supports staged rollout of a new micro-frontend-based implementation of the order history page. # .. toggle_category: micro-frontend @@ -27,8 +27,8 @@ def should_redirect_to_order_history_microfrontend(): ) -# .. toggle_name: REDIRECT_TO_ACCOUNT_MICROFRONTEND -# .. toggle_type: waffle_flag +# .. toggle_name: account.redirect_to_microfrontend +# .. toggle_implementation: WaffleFlag # .. toggle_default: False # .. toggle_description: Supports staged rollout of a new micro-frontend-based implementation of the account page. # .. toggle_category: micro-frontend diff --git a/openedx/features/learner_profile/toggles.py b/openedx/features/learner_profile/toggles.py index 076ecd89aa..a451798d50 100644 --- a/openedx/features/learner_profile/toggles.py +++ b/openedx/features/learner_profile/toggles.py @@ -11,8 +11,8 @@ from openedx.core.djangoapps.waffle_utils import WaffleFlag, WaffleFlagNamespace WAFFLE_FLAG_NAMESPACE = WaffleFlagNamespace(name='learner_profile') # Waffle flag to redirect to another learner profile experience. -# .. toggle_name: REDIRECT_TO_PROFILE_MICROFRONTEND -# .. toggle_type: waffle_flag +# .. toggle_name: learner_profile.redirect_to_microfrontend +# .. toggle_implementation: WaffleFlag # .. toggle_default: False # .. toggle_description: Supports staged rollout of a new micro-frontend-based implementation of the profile page. # .. toggle_category: micro-frontend