From df45be2e2016d4b28323a9d51653f2b63b13b1dd Mon Sep 17 00:00:00 2001
From: anjalia28 <51120262+anjalia28@users.noreply.github.com>
Date: Thu, 4 Feb 2021 01:48:14 +0530
Subject: [PATCH] [TSD] add toggle annotations for
FEATURES['ENABLE_DISCUSSION_SERVICE'] (#26205)
* add toggle annotations for FEATURES['ENABLE_DISCUSSION_SERVICE']
* added comments in cms/envs/common.py
---
cms/envs/common.py | 4 ++--
lms/envs/common.py | 16 +++++++++++++---
2 files changed, 15 insertions(+), 5 deletions(-)
diff --git a/cms/envs/common.py b/cms/envs/common.py
index fa20f8d3ba8..338b131981b 100644
--- a/cms/envs/common.py
+++ b/cms/envs/common.py
@@ -173,9 +173,9 @@ STUDIO_SHORT_NAME = _("Studio")
FEATURES = {
'GITHUB_PUSH': False,
- # for consistency in user-experience, keep the value of the following 3 settings
- # in sync with the ones in lms/envs/common.py
+ # See annotations in lms/envs/common.py for details.
'ENABLE_DISCUSSION_SERVICE': True,
+ # See annotations in lms/envs/common.py for details.
'ENABLE_TEXTBOOK': True,
# When True, all courses will be active, regardless of start date
diff --git a/lms/envs/common.py b/lms/envs/common.py
index 92c079b5826..bfee4ade0b0 100644
--- a/lms/envs/common.py
+++ b/lms/envs/common.py
@@ -112,8 +112,17 @@ FEATURES = {
## Doing so will cause all courses to be released on production
'DISABLE_START_DATES': False,
- # for consistency in user-experience, keep the value of the following 3 settings
- # in sync with the corresponding ones in cms/envs/common.py
+ # .. toggle_name: FEATURES['ENABLE_DISCUSSION_SERVICE']
+ # .. toggle_implementation: DjangoSetting
+ # .. toggle_default: True
+ # .. toggle_description: When True, it will enable the Discussion tab in courseware for all courses. Setting this
+ # to False will not contain inline discussion components and discussion tab in any courses.
+ # .. toggle_use_cases: open_edx
+ # .. toggle_creation_date: 2012-08-14
+ # .. toggle_warnings: If the discussion panel is present in the course and the value for this flag is False then,
+ # attempting to expand those components will cause errors. So, this should only be set to False with an LMS that
+ # is running courses that do not contain discussion components.
+ # For consistency in user-experience, keep the value in sync with the setting of the same name in the CMS.
'ENABLE_DISCUSSION_SERVICE': True,
# .. toggle_name: FEATURES['ENABLE_TEXTBOOK']
@@ -123,7 +132,8 @@ FEATURES = {
# .. toggle_use_cases: open_edx
# .. toggle_creation_date: 2014-03-27
# .. toggle_target_removal_date: None
- # .. toggle_warnings: None
+ # .. toggle_warnings: For consistency in user-experience, keep the value in sync with the setting of the same name
+ # in the CMS.
# .. toggle_tickets: https://github.com/edx/edx-platform/pull/3064
'ENABLE_TEXTBOOK': True,
--
GitLab