Skip to content

Commit

Permalink
Document 'matrix' option
Browse files Browse the repository at this point in the history
  • Loading branch information
JasperCraeghs committed Mar 18, 2024
1 parent 77c4047 commit 1faac17
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions doc/usage.rst
Original file line number Diff line number Diff line change
Expand Up @@ -657,6 +657,7 @@ A pie chart of documentation items can be generated using:
:colors: orange c b darkred #FF0000 g
:hidetitle:
:stats:
:matrix: uncovered, covered, executed, error,fail,pass
where the *id_set* arguments can be replaced by any Python regular expression. The *label_set* and *result* arguments
are comma-separated lists.
Expand Down Expand Up @@ -727,6 +728,11 @@ are comma-separated lists.
By providing the *stats* flag, some statistics (coverage percentage) are calculated and displayed below the
pie chart.

:matrix: *optional*, *multiple arguments (comma-separated)*

The *matrix* option renders a table with all items, grouped by pie chart label. By default, all labels, and thus,
all items are included in the table. You can customize the order and filter by providing a custom set of labels.

.. note::

In this example, if an RQT-item is linked to one or more TEST-items and at least one TEST-item is not linked
Expand Down

0 comments on commit 1faac17

Please sign in to comment.