From d9f894f54e03e93e9f2703b532f7928db3f539f9 Mon Sep 17 00:00:00 2001
From: Arthur Goldberg <artgoldberg@gmail.com>
Date: Tue, 13 Mar 2018 00:05:51 -0400
Subject: [PATCH] add some defaults to '-h' help

---
 karr_lab_build_utils/__main__.py | 26 +++++++++++++-------------
 karr_lab_build_utils/core.py     |  2 +-
 tests/test_core.py               |  2 +-
 3 files changed, 15 insertions(+), 15 deletions(-)

diff --git a/karr_lab_build_utils/__main__.py b/karr_lab_build_utils/__main__.py
index 80c92fa..1320226 100644
--- a/karr_lab_build_utils/__main__.py
+++ b/karr_lab_build_utils/__main__.py
@@ -147,7 +147,7 @@ class Meta:
         stacked_type = 'nested'
         arguments = [
             (['--dirname'], dict(
-                default='.', type=str, help='Path to the package')),
+                default='.', type=str, help="Path to the package; default='.'")),
         ]
 
     @expose(hide=True)
@@ -176,21 +176,21 @@ class Meta:
                     'Path to tests to run. '
                     'If the `test_path` environment variable is not defined, TEST_PATH defaults to `tests`.'))),
             (['--dirname'], dict(
-                type=str, default='.', help='Path to package to test')),
+                type=str, default='.', help="Path to package to test; default='.'")),
             (['--verbose'], dict(
-                default=False, action='store_true', help='True/False to display test output')),
+                default=False, action='store_true', help='if set display test output')),
             (['--with-xunit'], dict(
-                default=False, action='store_true', help='True/False to save test results to XML file')),
+                default=False, action='store_true', help='if set save test results to XML file')),
             (['--with-coverage'], dict(
-                default=False, action='store_true', help='True/False to assess code coverage')),
+                default=False, action='store_true', help='if set assess code coverage')),
             (['--coverage-dirname'], dict(
-                type=str, default='.', help='Directory to store coverage data')),
+                type=str, default='.', help="Directory to store coverage data; default='.'")),
             (['--coverage-type'], dict(
                 type=str, default='branch',
-                help='Type of coverage analysis to run {statement, branch, or multiple-decision}')),
+                help="Type of coverage analysis to run {statement, branch, or multiple-decision}; default='branch'")),
             (['--environment'], dict(
                 type=str, default='local',
-                help='Environment to run tests (local, docker, or circleci)')),
+                help="Environment to run tests (local, docker, or circleci); default='local'")),
             (['--ssh-key-filename'], dict(
                 type=str, default='~/.ssh/id_rsa', help='Path to GitHub SSH key')),
         ]
@@ -374,7 +374,7 @@ class Meta:
             (['tests_exit_code'], dict(
                 type=int, help='Exit code of the tests')),
             (['--dry-run'], dict(
-                default=False, dest='dry_run', action='store_true', help='If true, do not send results to Coveralls and Code Climate')),
+                default=False, dest='dry_run', action='store_true', help='If set, do not send results to Coveralls and Code Climate')),
         ]
 
     @expose(hide=True)
@@ -438,7 +438,7 @@ class Meta:
             (['--coverage-dirname'], dict(
                 default='.', type=str, help="Directory to save coverage reports, which defaults to '.'.")),
             (['--dry-run'], dict(
-                default=False, dest='dry_run', action='store_true', help='If true, do not send results to Coveralls and Code Climate')),
+                default=False, dest='dry_run', action='store_true', help='If set, do not send results to Coveralls and Code Climate')),
         ]
 
     @expose(hide=True)
@@ -486,7 +486,7 @@ class Meta:
             (['--coverage-dirname'], dict(
                 default='.', type=str, help="Directory to save coverage reports, which defaults to '.'.")),
             (['--dry-run'], dict(
-                default=False, dest='dry_run', action='store_true', help='If true, do not send results to Coveralls and Code Climate')),
+                default=False, dest='dry_run', action='store_true', help='If set, do not send results to Coveralls and Code Climate')),
         ]
 
     @expose(hide=True)
@@ -513,7 +513,7 @@ class Meta:
             (['--coverage-dirname'], dict(
                 default='.', type=str, help="Directory to save coverage reports, which defaults to '.'.")),
             (['--dry-run'], dict(
-                default=False, dest='dry_run', action='store_true', help='If true, do not send results to Coveralls')),
+                default=False, dest='dry_run', action='store_true', help='If set, do not send results to Coveralls')),
         ]
 
     @expose(hide=True)
@@ -537,7 +537,7 @@ class Meta:
             (['--coverage-dirname'], dict(
                 default='.', type=str, help="Directory to save coverage reports, which defaults to '.'.")),
             (['--dry-run'], dict(
-                default=False, dest='dry_run', action='store_true', help='If true, do not send results to Code Climate')),
+                default=False, dest='dry_run', action='store_true', help='If set, do not send results to Code Climate')),
         ]
 
     @expose(hide=True)
diff --git a/karr_lab_build_utils/core.py b/karr_lab_build_utils/core.py
index 9572163..312ee39 100644
--- a/karr_lab_build_utils/core.py
+++ b/karr_lab_build_utils/core.py
@@ -2,7 +2,7 @@
 
 :Author: Jonathan Karr <karr@mssm.edu>
 :Date: 2016-08-02
-:Copyright: 2016, Karr Lab
+:Copyright: 2016-2018, Karr Lab
 :License: MIT
 """
 
diff --git a/tests/test_core.py b/tests/test_core.py
index df7d1b3..3b19f7a 100644
--- a/tests/test_core.py
+++ b/tests/test_core.py
@@ -2,7 +2,7 @@
 
 :Author: Jonathan Karr <karr@mssm.edu>
 :Date: 2016-08-03
-:Copyright: 2016, Karr Lab
+:Copyright: 2016-2018, Karr Lab
 :License: MIT
 """