From c88202dff9817f9d860fa66668bb1b2be1674684 Mon Sep 17 00:00:00 2001 From: Jayram Nai Date: Wed, 24 Feb 2021 18:33:40 +0530 Subject: [PATCH] docs: add annotations for DISPLAY_HISTOGRAMS_TO_STAFF feature flag --- lms/envs/common.py | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/lms/envs/common.py b/lms/envs/common.py index 8dcd607b53..9952c72ea4 100644 --- a/lms/envs/common.py +++ b/lms/envs/common.py @@ -94,6 +94,16 @@ FEATURES = { # .. toggle_warnings: None # .. toggle_tickets: https://github.com/edx/edx-platform/pull/2425 'DISPLAY_DEBUG_INFO_TO_STAFF': True, + + # .. toggle_name: FEATURES['DISPLAY_HISTOGRAMS_TO_STAFF'] + # .. toggle_implementation: DjangoSetting + # .. toggle_default: False + # .. toggle_description: This displays histograms in the Staff Debug Info panel to course staff. + # .. toggle_use_cases: open_edx + # .. toggle_creation_date: 2014-02-13 + # .. toggle_warnings: Generating histograms requires scanning the courseware_studentmodule table on each view. This + # can make staff access to courseware very slow on large courses. + # .. toggle_tickets: https://github.com/edx/edx-platform/pull/2425 'DISPLAY_HISTOGRAMS_TO_STAFF': False, # For large courses this slows down courseware access for staff. 'REROUTE_ACTIVATION_EMAIL': False, # nonempty string = address for all activation emails