Sfoglia il codice sorgente

Docs: minor corrections

olinox 8 anni fa
parent
commit
d89278a01c
4 ha cambiato i file con 19 aggiunte e 16 eliminazioni
  1. 2 2
      docs/api.rst
  2. 12 6
      docs/cli.rst
  3. 4 7
      docs/dice_notation.rst
  4. 1 1
      docs/index.rst

+ 2 - 2
docs/api.rst

@@ -1,5 +1,5 @@
-API
-===
+API Reference
+=============
 
 Import the *xdice* library with `import dice`
 

+ 12 - 6
docs/cli.rst

@@ -18,15 +18,21 @@ Run ``python roll.py [options] <expr>``
 
 -  Basic use
 
-   ``python roll 1d6+1``
-   ``>> 2       ([1]+1)``
+::
+
+   python roll 1d6+1
+   >> 2       ([1]+1)
 
 -  Numeric score only (-s)
 
-   ``python roll -s 1d6+1``
-   ``>> 2``
+::
+
+   python roll -s 1d6+1
+   >> 2
 
 -  Verbose (-v)
 
-   ``python roll -v 2*(3D6L1+2D4)+R3(1d4+2)``
-   ``>> (2*(3d6l1(scores:[5, 6], dropped:[3])+2d4(scores:[2, 1]))+(1d4(scores:[4])+2+1d4(scores:[1])+2+1d4(scores:[4])+2))``
+::
+
+   python roll -v 2*(3D6L1+2D4)+R3(1d4+2)
+   >> (2*(3d6l1(scores:[5, 6], dropped:[3])+2d4(scores:[2, 1]))+(1d4(scores:[4])+2+1d4(scores:[1])+2+1d4(scores:[4])+2))

+ 4 - 7
docs/dice_notation.rst

@@ -1,15 +1,12 @@
 Dice Notation
--------------
+=============
 
 *Dice notation* is nearly fully understood by pydice.
 
-Case sensitivity
-^^^^^^^^^^^^^^^^
-
 *xdice* is case insensitive.
 
 Dice
-~~~~
+----
 
     Patterns describes here can be passed to the Dice.parse() class
     method, and will then return the corresponding Dice object.
@@ -60,7 +57,7 @@ Notes:
 
 
 Patterns
-~~~~~~~~
+--------
 
     Patterns describes here can be passed to the Pattern.parse() class
     method.
@@ -91,7 +88,7 @@ For example, the pattern ``R3(2d6+2)`` will roll ``2d6+2`` three times: ``(2d6+2
 
 
 Examples
-~~~~~~~~
+--------
 
 -  ``1d6`` 				> Roll a 6-sided die
 -  ``1d6+3`` 			> Roll a 6-sided die, then add 3

+ 1 - 1
docs/index.rst

@@ -4,7 +4,7 @@ Welcome to the documentation for xdice
 Contents:
 
 .. toctree::
-    :maxdepth: 2
+    :maxdepth: 3
 
     introduction
     dice_notation