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
23 lines
774 B
Python
23 lines
774 B
Python
"""
|
|
Toggles for Course API.
|
|
"""
|
|
|
|
|
|
from edx_toggles.toggles import LegacyWaffleFlag, LegacyWaffleFlagNamespace
|
|
|
|
COURSE_BLOCKS_API_NAMESPACE = LegacyWaffleFlagNamespace(name='course_blocks_api')
|
|
|
|
# .. toggle_name: course_blocks_api.hide_access_denials
|
|
# .. toggle_implementation: WaffleFlag
|
|
# .. toggle_default: False
|
|
# .. toggle_description: Waffle flag to hide access denial messages in the course blocks.
|
|
# .. 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.
|
|
HIDE_ACCESS_DENIALS_FLAG = LegacyWaffleFlag(
|
|
waffle_namespace=COURSE_BLOCKS_API_NAMESPACE,
|
|
flag_name='hide_access_denials',
|
|
module_name=__name__,
|
|
)
|