From 4bb8ea7c6a7f8017bb247c54e8c8a4eff7847a76 Mon Sep 17 00:00:00 2001 From: Casper da Costa-Luis Date: Wed, 2 Dec 2020 23:55:34 +0000 Subject: [PATCH] minor doc update --- README.rst | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/README.rst b/README.rst index f41cdcc..667864a 100644 --- a/README.rst +++ b/README.rst @@ -170,8 +170,9 @@ Documentation -v, --version Print module version and exit. --branch= Branch or tag [default: HEAD] up to which to check. --sort= [default: loc]|commits|files|hours|months. - --loc= [default: surviving]|ins(ertions)|del(etions) + --loc= surviving|ins(ertions)|del(etions) What `loc` represents. Use 'ins,del' to count both. + defaults to 'surviving' unless `--cost` is specified. --excl= Excluded files (default: None). In no-regex mode, may be a comma-separated list. Escape (\,) for a literal comma (may require \\, in shell). @@ -182,6 +183,8 @@ Documentation person-hours (based on commit times). Methods: month(s)|cocomo|hour(s)|commit(s). May be multiple comma-separated values. + Alters `--loc` default to imply 'ins' (COCOMO) or + 'ins,del' (hours). -n, --no-regex Assume are comma-separated exact matches rather than regular expressions [default: False]. NB: if regex is enabled ',' is equivalent to '|'.