docs: annotate lms progress tab ui waffle flag (#33233)

This commit is contained in:
Lakshya Khatri
2023-09-18 19:36:12 +05:30
committed by GitHub
parent 07979774a6
commit 3acb1d8590

View File

@@ -6,7 +6,17 @@ from openedx.core.djangoapps.waffle_utils import CourseWaffleFlag
WAFFLE_FLAG_NAMESPACE = 'course_home'
COURSE_HOME_MICROFRONTEND_PROGRESS_TAB = CourseWaffleFlag( # lint-amnesty, pylint: disable=toggle-missing-annotation
# .. toggle_name: course_home.course_home_mfe_progress_tab
# .. toggle_implementation: WaffleFlag
# .. toggle_default: False
# .. toggle_description: This toggle controls the user interface behavior of the progress tab in
# the Learning Management System. When set to True, the progress tab utilizes the newly introduced
# Learning MFE graphs. When set to False (default), it utilizes existing grade graph from edx-platform.
# .. toggle_use_cases: temporary
# .. toggle_creation_date: 2021-03-12
# .. toggle_target_removal_date: 2024-01-01
# .. toggle_tickets: https://github.com/openedx/edx-platform/pull/26978
COURSE_HOME_MICROFRONTEND_PROGRESS_TAB = CourseWaffleFlag(
f'{WAFFLE_FLAG_NAMESPACE}.course_home_mfe_progress_tab', __name__
)