chore: missing rubricoptions

adrienverge · Nov 21, 2024 · 186dcd9 · 186dcd9
1 parent b9aaf4f
commit 186dcd9
Showing 1 changed file with 13 additions and 0 deletions.
diff --git a/yamllint/rules/key_ordering.py b/yamllint/rules/key_ordering.py
@@ -22,6 +22,19 @@
 It also allows one to ignore certain keys by setting the ``ignored-keys``
 (PCRE regexes list) option.
 
+.. rubric:: Options
+
+* ``ignored-keys`` is a list of PCRE regexes defining a set of keys to be ignored while ordering, if
+  they match any regex. Default is an empty list.
+
+.. rubric:: Default values (when enabled)
+
+.. code-block:: yaml
+
+ rules:
+   key-ordering:
+     ignored-keys: []
+
 .. rubric:: Examples
 
 #. With ``key-ordering: {}``