From 1a4d5f656ebd19a7a4243a3970a0d3575bdbb0b7 Mon Sep 17 00:00:00 2001 From: Jillian Vogel Date: Thu, 20 Jun 2024 15:05:26 +0930 Subject: [PATCH] fix: address PR review --- README.rst | 4 ++-- completion_aggregator/settings/common.py | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/README.rst b/README.rst index 52272818..0fc4772c 100644 --- a/README.rst +++ b/README.rst @@ -52,9 +52,9 @@ Event tracking Like other parts of Open edX, the completion aggregator emits "tracking logs" events whenever completion aggregator records are created or updated by this plugin. These events can be used for analytics, for example to track learner progress in a course. -Event tracking is enabled by default for edx-platform, and so event tracking is also enabled by default in the completion aggregator. This can result in a lot of events being generated -- for example when a user completes the final block in a course, aggregator completion events will be generated for the containing unit, subsection, section, and course. +Event tracking is enabled by default for edx-platform, and so event tracking is also enabled by default in the completion aggregator. This can result in a lot of events being generated — for example when a user completes the final block in a course, aggregator completion events will be generated for the containing unit, subsection, section, and course. -You can limit which aggregator events are emitted by modifying the `COMPLETION_AGGREGATOR_TRACKING_EVENT_TYPES` setting to limit which block types (`course`, `chapter`, `sequential`, `vertical`) cause tracking events to be emitted. To disable sending any completion aggregator tracking events, set `COMPLETION_AGGREGATOR_TRACKING_EVENT_TYPES = None`. +You can limit which aggregator events are emitted by modifying the ``COMPLETION_AGGREGATOR_TRACKING_EVENT_TYPES`` setting to limit which block types (``course``, ``chapter``, ``sequential``, ``vertical``) cause tracking events to be emitted. To disable sending any completion aggregator tracking events, set ``COMPLETION_AGGREGATOR_TRACKING_EVENT_TYPES = None``. Installation and Configuration ------------------------------ diff --git a/completion_aggregator/settings/common.py b/completion_aggregator/settings/common.py index 271c8110..a4b8f0b3 100644 --- a/completion_aggregator/settings/common.py +++ b/completion_aggregator/settings/common.py @@ -19,7 +19,7 @@ def plugin_settings(settings): # Emit feature publishes progress events to track aggregated completion. # Defaults to the full set of block types subject to completion aggregation. # Block types may be removed from this list to limit the tracking log events emitted. - settings.COMPLETION_AGGREGATOR_TRACKING_EVENT_TYPES = settings.COMPLETION_AGGREGATOR_BLOCK_TYPES + settings.COMPLETION_AGGREGATOR_TRACKING_EVENT_TYPES = settings.COMPLETION_AGGREGATOR_BLOCK_TYPES.copy() # Synchronous completion aggregation is enabled by default settings.COMPLETION_AGGREGATOR_ASYNC_AGGREGATION = False