From c03e34af677f77969f8bff2815b8d501979a0249 Mon Sep 17 00:00:00 2001
From: Casper da Costa-Luis <casper.dcl@physics.org>
Date: Wed, 20 Jul 2016 21:27:38 +0100
Subject: [PATCH] common/known issues

---
 README.rst | 17 +++++++++++++++++
 1 file changed, 17 insertions(+)

diff --git a/README.rst b/README.rst
index cdfb6b74..35c72b05 100644
--- a/README.rst
+++ b/README.rst
@@ -195,6 +195,23 @@ Backing up a large directory?
     100%|███████████████████████████████▉| 8014/8014 [01:37<00:00, 82.29files/s]
 
 
+Help!
+-----
+
+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``.
+- 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.
+
+
 Documentation
 -------------