Skip to content

Commit 0c7e87c

Browse files
committed
Improved features list
1 parent 3d1ce3e commit 0c7e87c

2 files changed

Lines changed: 14 additions & 11 deletions

File tree

README.rst

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -28,10 +28,9 @@ operating with it on any Python application.
2828
Features
2929
--------
3030

31-
The library contains the following features:
32-
33-
- API for dice and dice notation, along classes to generate values from them
34-
- Parser to create API instances from the notation
31+
- Ply-based parser to generate objects for dice notation
32+
- Easy-to-use objects to handle the notation, just call the 'roll' method
33+
- Classes to support plain dice
3534

3635
Documentation
3736
-------------
@@ -80,14 +79,14 @@ the following command:
8079
Usage
8180
-----
8281

83-
The application has been coded in Python, without using any particular
82+
The application has been coded in Python, and does not require any particular
8483
framework.
8584

8685
To use it just import the parser:
8786

8887
>>> from dice_notation.parser import DiceParser
8988

90-
And then use it to parser a dice notation expression:
89+
And then use it to parse a dice notation expression:
9190

9291
>>> parser = DiceParser()
9392
>>> dice = parser.parse('1d6+2')

docs/source/index.rst

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,16 +2,20 @@
22
Dice Notation Tools for Python
33
==============================
44

5-
This is the documentation for a Python library. Change all the placeholder
6-
texts with actual information.
5+
Created on the late 70s for Dungeons & Dragons, the tabletop notation has
6+
become a standard on tabletop games, defining formulas used to generate random
7+
values with the help of dice.
8+
9+
These are very simple: 2d6+5 means “roll two dice, add their values and then
10+
add the number five to the result”.
711

812
--------
913
Features
1014
--------
1115

12-
- A feature
13-
- Another feature
14-
- A third feature
16+
- Ply-based parser to generate objects for dice notation
17+
- Easy-to-use objects to handle the notation, just call the 'roll' method
18+
- Classes to support plain dice
1519

1620
.. toctree::
1721
:hidden:

0 commit comments

Comments
 (0)