Skip to content

Commit 7e8da3e

Browse files
committed
tweaking docs
1 parent bcd4f81 commit 7e8da3e

1 file changed

Lines changed: 10 additions & 7 deletions

File tree

docs/index.rst

Lines changed: 10 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -10,23 +10,26 @@ Current Version: |version|
1010

1111
Dev tools for python.
1212

13+
The debug print command python never had (and some other handy tools).
14+
1315
Install
1416
-------
1517

1618
Assuming you have **python 3.5+** and pip installed, just::
1719

1820
pip install devtools
1921

20-
If ``pygments`` is installed *devtools* will colourise output to make it even more readable. The
21-
chances are you already have pygments installed if you're using ipython, otherwise it can be installed along
22+
If ``pygments`` is installed *devtools* will colourise output to make it even more readable.
23+
Chances are you already have pygments installed if you're using ipython, otherwise it can be installed along
2224
with *devtools* via ``pip install devtools[pygments]``.
2325

24-
*python-devtools* has no requirements beyond python and optionally pygments.
25-
2626
Debug print
2727
-----------
2828

29-
Example:
29+
Somehow in the 26 years (and counting) of activity development of python, no one thought to add a simple
30+
and readable way to print stuff during development. (If you know why this is, I'd love to hear an explanation).
31+
32+
The wait is over:
3033

3134
.. literalinclude:: examples/1_input.py
3235

@@ -39,7 +42,7 @@ you found down the back of a chair on the tube:
3942

4043
* Each output it prefixed with the file, line number and function where ``debug`` was called
4144
* the variable name or expression being printed is shown
42-
* each argument is printed "pretty" on a new line with
45+
* each argument is printed "pretty" on a new line
4346
* if ``pygments`` is installed the output will be highlighted
4447

4548
Complex usage
@@ -85,7 +88,7 @@ it's not that pretty, it also doesn't cope well with non standard python objects
8588
django querysets) which have their own pretty print functionality.
8689

8790
To get round this *devtools* comes with prettier print, my take on pretty printing. You can see it in use above
88-
in ``debug()``, but you can also call it directly:
91+
in ``debug()``, but it can also be used directly:
8992

9093
.. literalinclude:: examples/prettier.py
9194

0 commit comments

Comments
 (0)