From d6ff4b377fb6bc615e941988fbcaae71b9123edf Mon Sep 17 00:00:00 2001 From: Ned Batchelder Date: Fri, 10 Jun 2016 07:27:56 -0400 Subject: Final touch on docs for sort column --- CHANGES.rst | 2 +- doc/config.rst | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/CHANGES.rst b/CHANGES.rst index 3b232859..77acdb6e 100644 --- a/CHANGES.rst +++ b/CHANGES.rst @@ -8,7 +8,7 @@ Change history for Coverage.py Unreleased ---------- -- A new configuration option, ``report:sort``, controls what columns of the +- A new configuration option, ``report:sort``, controls what column of the text report is used to sort the rows. Thanks to Dan Wandschneider, this closes `issue 199`_. diff --git a/doc/config.rst b/doc/config.rst index 993ead97..7c1aeb2c 100644 --- a/doc/config.rst +++ b/doc/config.rst @@ -218,8 +218,8 @@ missing lines. See :ref:`cmd_summary` for more information. ``skip_covered`` (boolean, default False): Don't include files in the report that are 100% covered files. See :ref:`cmd_summary` for more information. -``sort`` (string, default "Name"): Sort report by the named column. Allowed -values: "Name", "Stmts", "Miss", or "Cover". +``sort`` (string, default "Name"): Sort the text report by the named column. +Allowed values are "Name", "Stmts", "Miss", "Branch", "BrPart", or "Cover". .. _config_html: -- cgit v1.2.1