Rooba
/
tqdm
mirror of https://github.com/tqdm/tqdm.git
1
1
Fork 0
Code Issues Packages Projects Releases Wiki Activity

minor doc fixes

This commit is contained in:
Casper da Costa-Luis 2015-10-12 17:30:24 +01:00 committed by Casper da Costa-Luis
parent b6b6f805b9
commit 4acf712aa3
2 changed files with 8 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
README.rst
View File

@ -13,7 +13,7 @@ iterable with "tqdm(iterable)", and you're done!
.. code:: python
from tqdm import tqdm
for i in tqdm(range(16)):
for i in tqdm(range(9)):
...
Here's what the output looks like:
@ -31,6 +31,7 @@ By comparison, the well established
an 800ns/iter overhead. It's a matter of taste, but we also like to think our
version is much more visually appealing.
Installation
------------
@ -50,6 +51,7 @@ Pull and install in the current directory:
pip install -e git+https://github.com/tqdm/tqdm.git@master#egg=tqdm
Documentation
-------------
@ -200,6 +202,7 @@ It is recommend to use ``miniters=1`` whenever there is potentially
large differences in iteration speed (e.g. downloading a file over
a patchy connection).
Contributions
-------------
@ -217,11 +220,13 @@ with the following command:
See the `CONTRIBUTE <CONTRIBUTE>`__ file for more information.
License
-------
`MIT LICENSE <LICENSE>`__.
Authors
-------

4
RELEASE
View File

@ -1,5 +1,5 @@
HOW TO MANAGE A NEW RELEASE
=============================
===========================
This file is intended for the project's maintainers and it describes
how to update, build and upload a new release.
@ -22,7 +22,7 @@ solely due to the VERSION file bumping.
CHECKING SETUP.PY
------------------------------------
-----------------
To check that the setup.py is OK for PyPi (eg, version number,
reStructuredText in README.rst intelligible for PyPi, which uses a