8ef8b35a54
A variety of updates were made to improve the toggle documentation: * Added comments to help ensure that the waffle(), waffle_switches(), waffle_flags() anti-pattern won't be contagious (copied). * Some minor toggle_description updates. * Removed empty toggle_target_removal_date annotations for non-temporary toggles. * Removed empty optional toggle_warnings annotations. * Removed empty optional toggle_tickets annotations. * Removed deprecated toggle_category, toggle_status, and toggle_expiration_date annotations. * Fixed some indents, use cases, and implementations. ARCHBOM-1721
50 lines
1.5 KiB
Python
50 lines
1.5 KiB
Python
"""
|
|
Waffle flags for instructor dashboard.
|
|
"""
|
|
|
|
from edx_toggles.toggles import LegacyWaffleFlag, LegacyWaffleFlagNamespace
|
|
|
|
WAFFLE_NAMESPACE = 'instructor'
|
|
# Namespace for instructor waffle flags.
|
|
WAFFLE_FLAG_NAMESPACE = LegacyWaffleFlagNamespace(name=WAFFLE_NAMESPACE)
|
|
|
|
# Waffle flag enable new data download UI on specific course.
|
|
# .. toggle_name: instructor.enable_data_download_v2
|
|
# .. toggle_implementation: WaffleFlag
|
|
# .. toggle_default: False
|
|
# .. toggle_description: instructor
|
|
# .. toggle_use_cases: open_edx
|
|
# .. toggle_creation_date: 2020-07-8
|
|
# .. toggle_tickets: PROD-1309
|
|
DATA_DOWNLOAD_V2 = LegacyWaffleFlag(
|
|
waffle_namespace=WAFFLE_FLAG_NAMESPACE,
|
|
flag_name='enable_data_download_v2',
|
|
module_name=__name__,
|
|
)
|
|
|
|
# .. toggle_name: verify_student.optimised_is_small_course
|
|
# .. toggle_implementation: WaffleFlag
|
|
# .. toggle_default: False
|
|
# .. 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.
|
|
# This may actually be a temporary toggle.
|
|
# .. toggle_tickets: PROD-1740
|
|
OPTIMISED_IS_SMALL_COURSE = LegacyWaffleFlag(
|
|
waffle_namespace=WAFFLE_FLAG_NAMESPACE,
|
|
flag_name='optimised_is_small_course',
|
|
module_name=__name__,
|
|
)
|
|
|
|
|
|
def data_download_v2_is_enabled():
|
|
"""
|
|
check if data download v2 is enabled.
|
|
"""
|
|
return DATA_DOWNLOAD_V2.is_enabled()
|
|
|
|
|
|
def use_optimised_is_small_course():
|
|
return OPTIMISED_IS_SMALL_COURSE.is_enabled()
|