improved __doc__

ShawnDriscoll · Oct 28, 2017 · 9df1e08 · 9df1e08
1 parent b62c052
commit 9df1e08
Show file tree

Hide file tree

Showing 7 changed files with 11 additions and 3 deletions.
diff --git a/diceroll.py b/diceroll.py
@@ -1,4 +1,6 @@
 #
+#   diceroll.py
+#
 #   Written for Python 2.5.4
 #
 #   To use this module: from diceroll import roll
@@ -8,6 +10,8 @@
 ##########################################################
 
 '''
+diecroll module containing roll()
+
 Usage:
     from diceroll import roll
     print roll('2D6')

diff --git a/diceroll_2.4.1b.zip b/diceroll_2.4.1b.zip
diff --git a/docs/build/.doctrees/environment.pickle b/docs/build/.doctrees/environment.pickle
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 0x0362F9E0>
+<generator object at 0x0360BE40>
 
     <script type="text/javascript">
       DOCUMENTATION_OPTIONS.COLLAPSE_MODINDEX = true;

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 0x036172D8>
+<generator object at 0x03689D28>
     <script type="text/javascript" src="_static/searchtools.js"></script>
 
   </head>

diff --git a/docs/build/searchindex.json b/docs/build/searchindex.json
diff --git a/docs/source/diceroll.py b/docs/source/diceroll.py
@@ -1,4 +1,6 @@
 #
+#   diceroll.py
+#
 #   Written for Python 2.5.4
 #
 #   To use this module: from diceroll import roll
@@ -8,6 +10,8 @@
 ##########################################################
 
 '''
+diecroll module containing roll()
+
 Usage:
     from diceroll import roll
     print roll('2D6')