From 58e0db83fe5d0d42aeaff7444b294988fec946ad Mon Sep 17 00:00:00 2001 From: Casper da Costa-Luis Date: Wed, 20 Jul 2016 21:32:29 +0100 Subject: [PATCH] note about idle, issue tracker --- README.rst | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) diff --git a/README.rst b/README.rst index 35c72b05..6e17b1d1 100644 --- a/README.rst +++ b/README.rst @@ -202,15 +202,17 @@ The most common issues relate to excessive output on multiple lines, instead of a neat one-line progress bar. - Consoles in general: require support for carriage return (``CR``, ``\r``). -- Nested progress bars - - Consoles in general: require support for moving cursors up to the - previous line. - - Windows: additionally may require the python module ``colorama``. +- Nested progress bars: + * Consoles in general: require support for moving cursors up to the + previous line. For example, `IDLE won't work `__. + * Windows: additionally may require the python module ``colorama``. - Wrapping enumerated iterables: use ``enumerate(tqdm(...))`` instead of ``tqdm(enumerate(...))``. The same applies to ``numpy.ndenumerate``. This is because enumerate functions tend to hide the length of iterables. - ``tqdm`` however, ~~is not that stupid~~ does not. + ``tqdm`` does not. +If you come across any other difficulties, browse/open issues +`here `__. Documentation -------------