From 8fa442b3c0e44d22ddb4d5c3fbf27ded34882e4a Mon Sep 17 00:00:00 2001 From: Jade Date: Tue, 15 Oct 2024 22:30:51 +0800 Subject: [PATCH] Add missing config options to epilogue docs (#2791) * Add missing config options to epilogue docs Resolves https://github.com/wpilibsuite/frc-docs/issues/2764 Signed-off-by: Jade Turner * Update source/docs/software/telemetry/robot-telemetry-with-annotations.rst Co-authored-by: Jason Daming --------- Signed-off-by: Jade Turner Co-authored-by: Jason Daming --- .../software/telemetry/robot-telemetry-with-annotations.rst | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/source/docs/software/telemetry/robot-telemetry-with-annotations.rst b/source/docs/software/telemetry/robot-telemetry-with-annotations.rst index 41d1e937f4..0be6921018 100644 --- a/source/docs/software/telemetry/robot-telemetry-with-annotations.rst +++ b/source/docs/software/telemetry/robot-telemetry-with-annotations.rst @@ -72,6 +72,10 @@ The names of log entries can be changed using the ``name`` configuration option - Sets the specific importance level for the annotated element, which can be used by the runtime ``minimumImportance`` configuration to control what data to log. If placed on a class, this sets the *default* importance level for all contained elements, which can be overridden on an element-by-element basis. Defaults to ``DEBUG``. * - Strategy (class only) - Sets the opt-in/opt-out strategy to use for logging elements in the annotated class. Defaults to opt-out, which means every loggable element in the class will be logged unless opted out using the ``@NotLogged`` annotation. Setting this to opt-in gives finer control over what gets logged, but takes more work to set up by manually annotating all the opted-in elements. Setting this option on a field or method has no effect. + * - Logging Period + - Sets the amount of time between logging calls. + * - Logging Period Offset + - Sets the offset of logging calls relative to the robot periodic functions. .. tab-set::