Added annotations for ENABLE_ANNOUNCEMENTS feature flag

fixed quality violations

Changed indentation
This commit is contained in:
zia.fazal@arbisoft.com
2021-02-15 19:39:20 +05:00
parent d5c4ca3c68
commit d45d978aab

View File

@@ -4,6 +4,17 @@
def plugin_settings(settings):
"""
Common settings for Announcements
.. toggle_name: FEATURES['ENABLE_ANNOUNCEMENTS']
.. toggle_implementation: SettingDictToggle
.. toggle_default: False
.. toggle_description: This feature can be enabled to show system wide announcements
on the sidebar of the learner dashboard. Announcements can be created by Global Staff
users on maintenance dashboard of studio. Maintenance dashboard can accessed at
https://{studio.domain}/maintenance
.. toggle_warnings: TinyMCE is needed to show an editor in the studio.
.. toggle_use_cases: open_edx
.. toggle_creation_date: 2017-11-08
.. toggle_tickets: https://github.com/edx/edx-platform/pull/16496
"""
settings.FEATURES['ENABLE_ANNOUNCEMENTS'] = False
# Configure number of announcements to show per page