Merge pull request #21902 from edx/diana/annotate-toggles

Annotate a few of the course_experience waffle flags.

openedx/features/course_experience/__init__.py

@@ -24,9 +24,31 @@ DISPLAY_COURSE_SOCK_FLAG = CourseWaffleFlag(WAFFLE_FLAG_NAMESPACE, 'display_cour
 COURSE_PRE_START_ACCESS_FLAG = WaffleFlag(WAFFLE_FLAG_NAMESPACE, 'pre_start_access')
 
 # Waffle flag to enable a review page link from the unified home page.
+# .. toggle_name: course_experience.show_reviews_tool
+# .. toggle_implementation: CourseWaffleFlag
+# .. toggle_default: False
+# .. toggle_description: Used with our integration with CourseTalk to display reviews for a course.
+# .. toggle_category: course_experience
+# .. toggle_use_cases: monitored_rollout
+# .. toggle_creation_date: 2017-06-19
+# .. toggle_expiration_date: ???
+# .. toggle_warnings: We are no longer integrating with CourseTalk, so this probably should be deprecated and the code for reviews should be removed.
+# .. toggle_tickets: DEPR-48
+# .. toggle_status: unsupported
 SHOW_REVIEWS_TOOL_FLAG = CourseWaffleFlag(WAFFLE_FLAG_NAMESPACE, 'show_reviews_tool')
 
 # Waffle flag to enable the setting of course goals.
+# .. toggle_name: course_experience.enable_course_goals
+# .. toggle_implementation: CourseWaffleFlag
+# .. toggle_default: False
+# .. toggle_description: Used to determine whether or not to use course goals for the particular course.
+# .. toggle_category: course_experience
+# .. toggle_use_cases: opt_out?, monitored_rollout?
+# .. toggle_creation_date: 2017-09-11
+# .. toggle_expiration_date: ???
+# .. toggle_warnings: N/A
+# .. toggle_tickets: N/A
+# .. toggle_status: supported
 ENABLE_COURSE_GOALS = CourseWaffleFlag(WAFFLE_FLAG_NAMESPACE, 'enable_course_goals')
 
 # Waffle flag to control the display of the hero
@@ -36,9 +58,17 @@ SHOW_UPGRADE_MSG_ON_COURSE_HOME = CourseWaffleFlag(WAFFLE_FLAG_NAMESPACE, 'show_
 UPGRADE_DEADLINE_MESSAGE = CourseWaffleFlag(WAFFLE_FLAG_NAMESPACE, 'upgrade_deadline_message')
 
 # Waffle flag to switch between the 'welcome message' and 'latest update' on the course home page.
-# Important Admin Note: This is meant to be configured using waffle_utils course
-#   override only.  Either do not create the actual waffle flag, or be sure to unset the
-#   flag even for Superusers.
+# .. toggle_name: course_experience.latest_update
+# .. toggle_implementation: CourseWaffleFlag
+# .. toggle_default: False
+# .. toggle_description: Used to switch between 'welcome message' and 'latest update' on the course home page.
+# .. toggle_category: course_experience
+# .. toggle_use_cases: opt_out?
+# .. toggle_creation_date: 2017-09-11
+# .. toggle_expiration_date: ???
+# .. toggle_warnings: This is meant to be configured using waffle_utils course override only.  Either do not create the actual waffle flag, or be sure to unset the flag even for Superusers.
+# .. toggle_tickets: N/A
+# .. toggle_status: supported
 LATEST_UPDATE_FLAG = CourseWaffleFlag(WAFFLE_FLAG_NAMESPACE, 'latest_update')
 
 # Waffle flag to enable the use of Bootstrap for course experience pages

openedx/features/course_experience/waffle.py

@@ -9,6 +9,17 @@ from openedx.core.djangoapps.waffle_utils import WaffleSwitchNamespace
 WAFFLE_NAMESPACE = u'course_experience'
 
 # Switches
+# .. toggle_name: course_experience.enable_about_sidebar_html
+# .. toggle_implementation: CourseWaffleFlag
+# .. toggle_default: False
+# .. toggle_description: Used to determine whether to show custom HTML in the sidebar on the internal course about page.
+# .. toggle_category: course-experience
+# .. toggle_use_cases: open_edx
+# .. toggle_creation_date: 2018-01-26
+# .. toggle_expiration_date: ???
+# .. toggle_warnings: N/A
+# .. toggle_tickets: N/A
+# .. toggle_status: supported
 ENABLE_COURSE_ABOUT_SIDEBAR_HTML = u'enable_about_sidebar_html'