Andal.LND/edx-platform
6
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

doc: Correctly annotate the setting name.

Browse Source 
The `setting_name` annotation needed a space before it so that it's
picked up properly by the toggle annotations tooling.
This commit is contained in:
Feanil Patel
2021-03-01 16:35:41 -05:00
parent fe8e959559
commit d2343b1f07
1 changed files with 2 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
openedx/core/lib/request_utils.py
View File

@@ -142,13 +142,13 @@ class CookieMonitoringMiddleware(MiddlewareMixin):
if not CAPTURE_COOKIE_SIZES.is_enabled():
return
# ..setting_name: TOP_N_COOKIES_CAPTURED
# .. setting_name: TOP_N_COOKIES_CAPTURED
# .. setting_default: 5
# .. setting_description: The number of the largest cookies to capture when monitoring. Capture fewer cookies
# if you need to save on monitoring resources.
# .. setting_warning: Depends on the `request_utils.capture_cookie_sizes` toggle being enabled.
top_n_cookies_captured = getattr(settings, "TOP_N_COOKIES_CAPTURED", 5)
# ..setting_name: TOP_N_COOKIE_GROUPS_CAPTURED
# .. setting_name: TOP_N_COOKIE_GROUPS_CAPTURED
# .. setting_default: 5
# .. setting_description: The number of the largest cookie groups to capture when monitoring. Capture
# fewer cookies if you need to save on monitoring resources.