help update

ShawnDriscoll · Aug 1, 2019 · 2d7e86c · 2d7e86c
1 parent f55081d
commit 2d7e86c
Show file tree

Hide file tree

Showing 19 changed files with 34 additions and 18 deletions.
diff --git a/diceroll.py b/diceroll.py
@@ -354,7 +354,9 @@ def roll(dice):
     diceroll_log.info('diceroll was run without roll() called.  Help will be sent if needed.')
     print
     if len(sys.argv) < 2:
-        print "     Type 'diceroll.py -h' for help"
+        print '     Type:'
+        print "     'diceroll.py -h' for help"
+        print "     'diceroll.py -v' for version"
     elif sys.argv[1] in ['-h', '/h', '--help', '-?', '/?']:
         print '     diceroll is a module (containing a roll function)'
         print '     that needs to be imported into Python.'
@@ -373,6 +375,8 @@ def roll(dice):
         print
         print '     Or just:'
         print '     C:\>diceroll.py 2d6'
+    elif sys.argv[1] in ['-v', '/v', '--version']:
+        print '     roll(), release version ' + __release__ + ' for Classic Python 2.5.4'
     else:
         dice = sys.argv[1]
         if "roll('" in dice:

diff --git a/docs/build/.doctrees/environment.pickle b/docs/build/.doctrees/environment.pickle
diff --git a/docs/build/.doctrees/tutorial.doctree b/docs/build/.doctrees/tutorial.doctree
diff --git a/docs/build/about_the_author.html b/docs/build/about_the_author.html
@@ -89,7 +89,7 @@ <h3>Navigation</h3>
     </div>
     <div class="footer">
       &copy; Copyright 2019, SHONNER CORP.
-      Last updated on Jul 20, 2019.
+      Last updated on Aug 01, 2019.
       Created using <a href="http://sphinx.pocoo.org/">Sphinx</a>.
     </div>
   </body>

diff --git a/docs/build/debugging.html b/docs/build/debugging.html
@@ -136,7 +136,7 @@ <h3>Navigation</h3>
     </div>
     <div class="footer">
       &copy; Copyright 2019, SHONNER CORP.
-      Last updated on Jul 20, 2019.
+      Last updated on Aug 01, 2019.
       Created using <a href="http://sphinx.pocoo.org/">Sphinx</a>.
     </div>
   </body>

diff --git a/docs/build/designers_notes.html b/docs/build/designers_notes.html
@@ -203,7 +203,7 @@ <h3>Navigation</h3>
     </div>
     <div class="footer">
       &copy; Copyright 2019, SHONNER CORP.
-      Last updated on Jul 20, 2019.
+      Last updated on Aug 01, 2019.
       Created using <a href="http://sphinx.pocoo.org/">Sphinx</a>.
     </div>
   </body>

diff --git a/docs/build/diceroll.html b/docs/build/diceroll.html
@@ -113,7 +113,7 @@ <h3>Navigation</h3>
     </div>
     <div class="footer">
       &copy; Copyright 2019, SHONNER CORP.
-      Last updated on Jul 20, 2019.
+      Last updated on Aug 01, 2019.
       Created using <a href="http://sphinx.pocoo.org/">Sphinx</a>.
     </div>
   </body>

diff --git a/docs/build/genindex.html b/docs/build/genindex.html
@@ -99,7 +99,7 @@ <h3>Navigation</h3>
     </div>
     <div class="footer">
       &copy; Copyright 2019, SHONNER CORP.
-      Last updated on Jul 20, 2019.
+      Last updated on Aug 01, 2019.
       Created using <a href="http://sphinx.pocoo.org/">Sphinx</a>.
     </div>
   </body>

diff --git a/docs/build/glossary.html b/docs/build/glossary.html
@@ -178,7 +178,7 @@ <h3>Navigation</h3>
     </div>
     <div class="footer">
       &copy; Copyright 2019, SHONNER CORP.
-      Last updated on Jul 20, 2019.
+      Last updated on Aug 01, 2019.
       Created using <a href="http://sphinx.pocoo.org/">Sphinx</a>.
     </div>
   </body>

diff --git a/docs/build/index.html b/docs/build/index.html
@@ -165,7 +165,7 @@ <h3>Navigation</h3>
     </div>
     <div class="footer">
       &copy; Copyright 2019, SHONNER CORP.
-      Last updated on Jul 20, 2019.
+      Last updated on Aug 01, 2019.
       Created using <a href="http://sphinx.pocoo.org/">Sphinx</a>.
     </div>
   </body>

diff --git a/docs/build/introduction.html b/docs/build/introduction.html
@@ -234,7 +234,7 @@ <h3>Navigation</h3>
     </div>
     <div class="footer">
       &copy; Copyright 2019, SHONNER CORP.
-      Last updated on Jul 20, 2019.
+      Last updated on Aug 01, 2019.
       Created using <a href="http://sphinx.pocoo.org/">Sphinx</a>.
     </div>
   </body>

diff --git a/docs/build/license.html b/docs/build/license.html
@@ -126,7 +126,7 @@ <h3>Navigation</h3>
     </div>
     <div class="footer">
       &copy; Copyright 2019, SHONNER CORP.
-      Last updated on Jul 20, 2019.
+      Last updated on Aug 01, 2019.
       Created using <a href="http://sphinx.pocoo.org/">Sphinx</a>.
     </div>
   </body>

diff --git a/docs/build/modindex.html b/docs/build/modindex.html
@@ -20,7 +20,7 @@
     <link rel="index" title="Global index" href="genindex.html" />
     <link rel="search" title="Search" href="search.html" />
     <link rel="top" title="diceroll 2.4 Operations Manual" href="index.html" />
-<generator object at 0x037EAB48>
+<generator object at 0x03568440>
 
     <script type="text/javascript">
       DOCUMENTATION_OPTIONS.COLLAPSE_MODINDEX = true;
@@ -92,7 +92,7 @@ <h3>Navigation</h3>
     </div>
     <div class="footer">
       &copy; Copyright 2019, SHONNER CORP.
-      Last updated on Jul 20, 2019.
+      Last updated on Aug 01, 2019.
       Created using <a href="http://sphinx.pocoo.org/">Sphinx</a>.
     </div>
   </body>

diff --git a/docs/build/samples.html b/docs/build/samples.html
@@ -191,7 +191,7 @@ <h3>Navigation</h3>
     </div>
     <div class="footer">
       &copy; Copyright 2019, SHONNER CORP.
-      Last updated on Jul 20, 2019.
+      Last updated on Aug 01, 2019.
       Created using <a href="http://sphinx.pocoo.org/">Sphinx</a>.
     </div>
   </body>

diff --git a/docs/build/search.html b/docs/build/search.html
@@ -20,7 +20,7 @@
     <link rel="index" title="Global index" href="genindex.html" />
     <link rel="search" title="Search" href="" />
     <link rel="top" title="diceroll 2.4 Operations Manual" href="index.html" />
-<generator object at 0x038E1A30>
+<generator object at 0x03867B20>
     <script type="text/javascript" src="_static/searchtools.js"></script>
 
   </head>
@@ -83,7 +83,7 @@ <h3>Navigation</h3>
     </div>
     <div class="footer">
       &copy; Copyright 2019, SHONNER CORP.
-      Last updated on Jul 20, 2019.
+      Last updated on Aug 01, 2019.
       Created using <a href="http://sphinx.pocoo.org/">Sphinx</a>.
     </div>
   </body>

diff --git a/docs/build/searchindex.json b/docs/build/searchindex.json
diff --git a/docs/build/tutorial.html b/docs/build/tutorial.html
@@ -126,6 +126,10 @@ <h2>Rolling the Dice<a class="headerlink" href="#rolling-the-dice" title="Permal
 C:\&gt;diceroll.py 2d6-2
 
 Your 2D6-2 roll is 7.</pre>
+<div class="admonition note">
+<p class="first admonition-title">Note</p>
+<p class="last">Typing <tt class="docutils literal"><span class="pre">diceroll.py</span> <span class="pre">-h</span></tt> will provide some help.</p>
+</div>
 <p><em>New in version 2.4.1</em></p>
 <p>A TEST roll that calculates percentages for 2D6 has been added:</p>
 <div class="highlight"><pre><span class="gp">&gt;&gt;&gt; </span><span class="n">roll</span><span class="p">(</span><span class="s">&#39;test&#39;</span><span class="p">)</span>
@@ -203,7 +207,7 @@ <h3>Navigation</h3>
     </div>
     <div class="footer">
       &copy; Copyright 2019, SHONNER CORP.
-      Last updated on Jul 20, 2019.
+      Last updated on Aug 01, 2019.
       Created using <a href="http://sphinx.pocoo.org/">Sphinx</a>.
     </div>
   </body>

diff --git a/docs/source/diceroll.py b/docs/source/diceroll.py
@@ -354,7 +354,9 @@ def roll(dice):
     diceroll_log.info('diceroll was run without roll() called.  Help will be sent if needed.')
     print
     if len(sys.argv) < 2:
-        print "     Type 'diceroll.py -h' for help"
+        print '     Type:'
+        print "     'diceroll.py -h' for help"
+        print "     'diceroll.py -v' for version"
     elif sys.argv[1] in ['-h', '/h', '--help', '-?', '/?']:
         print '     diceroll is a module (containing a roll function)'
         print '     that needs to be imported into Python.'
@@ -373,6 +375,8 @@ def roll(dice):
         print
         print '     Or just:'
         print '     C:\>diceroll.py 2d6'
+    elif sys.argv[1] in ['-v', '/v', '--version']:
+        print '     roll(), release version ' + __release__ + ' for Classic Python 2.5.4'
     else:
         dice = sys.argv[1]
         if "roll('" in dice:

diff --git a/docs/source/tutorial.rst b/docs/source/tutorial.rst
@@ -71,6 +71,10 @@ D00 has been replaced with D100.
 
 .. literalinclude:: databox2.dat
 
+.. note::
+
+    Typing ``diceroll.py -h`` will provide some help.
+
 *New in version 2.4.1*
 
 A TEST roll that calculates percentages for 2D6 has been added: