From 4acf712aa3212b6c5b1a40186d7a8920755077d6 Mon Sep 17 00:00:00 2001 From: Casper da Costa-Luis Date: Mon, 12 Oct 2015 17:30:24 +0100 Subject: [PATCH] minor doc fixes --- README.rst | 7 ++++++- RELEASE | 4 ++-- 2 files changed, 8 insertions(+), 3 deletions(-) diff --git a/README.rst b/README.rst index 105921b2..6c4eb908 100644 --- a/README.rst +++ b/README.rst @@ -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 `__ file for more information. + License ------- `MIT LICENSE `__. + Authors ------- diff --git a/RELEASE b/RELEASE index dd3a77a4..9084d7d3 100644 --- a/RELEASE +++ b/RELEASE @@ -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