Skip to content

Commit

Permalink
Update README.rst
Browse files Browse the repository at this point in the history
  • Loading branch information
thenithinbalaji authored Mar 8, 2022
1 parent ff47036 commit 513cbfb
Showing 1 changed file with 17 additions and 13 deletions.
30 changes: 17 additions & 13 deletions README.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
Rand Toys
=========

``pyrandtoys`` is a python module containing probability-based toys
``pyrandtoys`` is a python module containing probability-based toys
functions. It works offline and is compatible with both Python 2 and 3.

Installation
Expand All @@ -21,9 +21,9 @@ Usage
Dice:
^^^^^

**Optional:** Number of Dice ``<int>``
**Default:** Number of Dice = 1
**Return Type:** ``<tuple>``
+ **Optional:** Number of Dice ``<int>``
+ **Default:** Number of Dice = 1
+ **Return Type:** ``<tuple>``

::

Expand All @@ -32,8 +32,9 @@ Dice:
Coin:
^^^^^

**Optional:** Number of Coins ``<int>`` **Default:** Number of Coins = 1
**Return Type:** ``<tuple>``
+ **Optional:** Number of Coins ``<int>``
+ **Default:** Number of Coins = 1
+ **Return Type:** ``<tuple>``

::

Expand All @@ -42,8 +43,9 @@ Coin:
Similar Toys:
^^^^^^^^^^^^^

**Optional:** Number of Items ``<int>`` **Default:** Number of Items = 1
**Return Type:** ``<tuple>``
+ **Optional:** Number of Items ``<int>``
+ **Default:** Number of Items = 1
+ **Return Type:** ``<tuple>``

::

Expand All @@ -54,8 +56,9 @@ Similar Toys:
Spinner:
^^^^^^^^

**Required:** Lower & Upper Limits ``<int>`` **Default:** Lower Limit =
0 **Return Type:** ``<tuple>``
+ **Required:** Lower & Upper Limits ``<int>``
+ **Default:** Lower Limit = 0
+ **Return Type:** ``<tuple>``

::

Expand All @@ -64,10 +67,11 @@ Spinner:
Toy Combinations:
^^^^^^^^^^^^^^^^^

**Return Type:** ``<tuple>`` **Default:** Number of Toys = 0
+ **Return Type:** ``<tuple>``
+ **Default:** Number of Toys = 0

**If you want to use a combination of toys then,** **Required:** List of
toys as ``<list>``,\ ``<tuple>``
+ **If you want to use a combination of toys then,**
**Required:** List of toys as ``<list>``,\ ``<tuple>``

::

Expand Down

0 comments on commit 513cbfb

Please sign in to comment.