refactor: rename toggle_warnings to toggle_warning (#30458)
Rename toggle_warnings to toggle_warning for consistency with setting_warning.
This commit is contained in:
@@ -16,7 +16,7 @@ from .models import BlockStructureConfiguration
|
||||
# .. toggle_description: When enabled, the block structure cache is invalidated when changes to
|
||||
# courses are published. If `block_structure.storage_backing_for_cache` is active, all block
|
||||
# structures related to the published course are also cleared from storage.
|
||||
# .. toggle_warnings: This switch will likely be deprecated and removed.
|
||||
# .. toggle_warning: This switch will likely be deprecated and removed.
|
||||
# .. toggle_use_cases: temporary
|
||||
# .. toggle_creation_date: 2017-02-23
|
||||
# .. toggle_target_removal_date: 2017-05-23
|
||||
@@ -34,7 +34,7 @@ INVALIDATE_CACHE_ON_PUBLISH = WaffleSwitch(
|
||||
# like a database, which provides an additional backup for cache misses, instead having them
|
||||
# regenerated. The regenration of block structures is a time consuming process. Therefore,
|
||||
# enabling this switch is recommended for Production.
|
||||
# .. toggle_warnings: Depends on `BLOCK_STRUCTURES_SETTINGS['STORAGE_CLASS']` and
|
||||
# .. toggle_warning: Depends on `BLOCK_STRUCTURES_SETTINGS['STORAGE_CLASS']` and
|
||||
# `BLOCK_STRUCTURES_SETTINGS['STORAGE_KWARGS']`.
|
||||
# This switch will likely be deprecated and removed.
|
||||
# The annotation will be updated with the DEPR ticket once that process has started.
|
||||
@@ -54,7 +54,7 @@ STORAGE_BACKING_FOR_CACHE = WaffleSwitch(
|
||||
# .. toggle_description: Raises an error if the requested block structure does not exist in block
|
||||
# structure store, or if it is outdated. Block structure store refers to both cache and storage,
|
||||
# if enabled.
|
||||
# .. toggle_warnings: This switch will likely be deprecated and removed.
|
||||
# .. toggle_warning: This switch will likely be deprecated and removed.
|
||||
# The annotation will be updated with the DEPR ticket once that process has started.
|
||||
# .. toggle_use_cases: temporary
|
||||
# .. toggle_creation_date: 2017-02-23
|
||||
|
||||
Reference in New Issue
Block a user