From: Alexander Vasarab <alexander@wylark.com>
Date: Wed, 24 Jun 2020 03:29:44 +0000 (-0700)
Subject: Small improvements to interface and help text
X-Git-Tag: v2.1.0~9
X-Git-Url: https://wylark.com/src/munter.git/commitdiff_plain/e8d14d51e3e6a0c11c58f93b92b2a6e052218339?ds=sidebyside;hp=-c

Small improvements to interface and help text

- Add sensible defaults to time_calc () for library users
- Improve usage text
---

e8d14d51e3e6a0c11c58f93b92b2a6e052218339
diff --git a/munter/munter.py b/munter/munter.py
index 7179e52..234ec9b 100644
--- a/munter/munter.py
+++ b/munter/munter.py
@@ -25,7 +25,7 @@ rates = {
 unit_choices = ['metric', 'imperial']
 travel_mode_choices = rates.keys()
 
-def time_calc(distance, elevation, rate, units):
+def time_calc(distance, elevation, rate='uphill', units='imperial'):
     retval = {}
 
     if units not in unit_choices:
@@ -80,7 +80,8 @@ def print_pretty_estimate(est):
     print("\t └───────────────────────────────┘\n")
 
 def get_parser():
-    parser = argparse.ArgumentParser(description='Munter Time Calculation')
+    parser = argparse.ArgumentParser(description='Implementation of '
+        'the Munter time calculation')
 
     parser.add_argument('--distance',
         '-d',
@@ -99,7 +100,7 @@ def get_parser():
         type=str,
         default='uphill',
         choices=travel_mode_choices, required=False,
-        help='Travel mode (flat, by default)')
+        help='Travel mode (uphill, by default)')
 
     parser.add_argument('--units',
         '-u',
@@ -113,7 +114,8 @@ def get_parser():
         '-p',
         action='store_true',
         default=False,
-        required=False);
+        required=False,
+        help="Make output pretty");
 
     return parser
 
@@ -126,7 +128,8 @@ def main():
     units = opts.units
     travel_mode = opts.travel_mode
 
-    time_estimate = time_calc(distance, elevation, travel_mode, units=units)
+    time_estimate = time_calc(distance=distance, elevation=elevation,
+        rate=travel_mode, units=units)
 
     if opts.pretty:
         print_pretty_estimate(time_estimate)