Skip to content

Commit

Permalink
docs: update toggle docstring
Browse files Browse the repository at this point in the history
  • Loading branch information
dyudyunov committed Aug 16, 2023
1 parent caee0a4 commit a581223
Showing 1 changed file with 6 additions and 3 deletions.
9 changes: 6 additions & 3 deletions xmodule/course_block.py
Original file line number Diff line number Diff line change
Expand Up @@ -61,12 +61,15 @@
# .. toggle_name: FEATURES['CREATE_COURSE_WITH_DEFAULT_ENROLLMENT_START_DATE']
# .. toggle_implementation: SettingDictToggle
# .. toggle_default: False
# .. toggle_description: The default behavior, when this is disabled, is that newly created course has no
# .. toggle_description: The default behavior, when this is disabled, is that a newly created course has no
# enrollment_start date set. When the feature is enabled - the newly created courses will have the
# enrollment_start_date set to DEFAULT_START_DATE.
# enrollment_start_date set to DEFAULT_START_DATE. This is intended to be a permanent option.
# This toggle affects the course listing pages (platform's index page, /courses page) when course search is
# performed using the `lms.djangoapp.branding.get_visible_courses` method and the
# COURSE_CATALOG_VISIBILITY_PERMISSION setting is set to 'see_exists'. Switching the toggle to True will prevent
# the newly created (empty) course from appearing in the course listing.
# .. toggle_use_cases: open_edx
# .. toggle_creation_date: 2023-06-22
# .. toggle_target_removal_date: This is intended to be a permanent option.
CREATE_COURSE_WITH_DEFAULT_ENROLLMENT_START_DATE = SettingDictToggle(
"FEATURES", "CREATE_COURSE_WITH_DEFAULT_ENROLLMENT_START_DATE", default=False, module_name=__name__
)
Expand Down

0 comments on commit a581223

Please sign in to comment.