update docs

secureworks · Mar 9, 2023 · 8fefd2e · 8fefd2e
1 parent 0de54be
commit 8fefd2e
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 1 deletion.
diff --git a/docs/conf.py b/docs/conf.py
@@ -66,7 +66,7 @@
 #
 # This is also used if you do content translation via gettext catalogs.
 # Usually you set "language" from the command line for these cases.
-language = None
+language = "en"
 
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.

diff --git a/docs/usage.rst b/docs/usage.rst
@@ -126,6 +126,12 @@ The statistics command line option allows a user to to easily see what
 metadata key-value pairs the ruleset contains to assist in building a
 filter string.
 
+.. note::
+    If a filter string is provided, or other options to manipulate the metadata (e.g.
+    :ref:`Normalize`, :ref:`Modify Metadata`) are set, along with a request for
+    statistics, then the filter and/or other manipulations are performed first,
+    and the statistics outputted apply to the filtered/modified ruleset.
+
 If no key names are passed, summary info on all present keys is
 displayed:
 

diff --git a/requirements.txt b/requirements.txt
@@ -1,2 +1,3 @@
 boolean.py>=3.6
 python-dateutil
+pyyaml