From d45d978aab5b19bbd78ec741838515fefa1da73b Mon Sep 17 00:00:00 2001 From: "zia.fazal@arbisoft.com" Date: Mon, 15 Feb 2021 19:39:20 +0500 Subject: [PATCH] Added annotations for ENABLE_ANNOUNCEMENTS feature flag fixed quality violations Changed indentation --- openedx/features/announcements/settings/common.py | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/openedx/features/announcements/settings/common.py b/openedx/features/announcements/settings/common.py index e4c87d6008..1683dc1a3c 100644 --- a/openedx/features/announcements/settings/common.py +++ b/openedx/features/announcements/settings/common.py @@ -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