Document echo_via_pager + generator usage

pallets · Jan 8, 2018 · dda3aec · dda3aec
1 parent 532aa83
commit dda3aec
Showing 1 changed file with 11 additions and 0 deletions.
diff --git a/docs/utils.rst b/docs/utils.rst
@@ -114,6 +114,17 @@ Example:
         click.echo_via_pager('\n'.join('Line %d' % idx
                                        for idx in range(200)))
 
+If you want to use the pager for a lot of text, especially if generating everything in advance would take a lot of time, you can pass a generator (or generator function) instead of a string:
+
+.. click:example::
+    def _generate_output():
+        for idx in range(50000):
+            yield "Line %d\n" % idx
+
+    @click.command()
+    def less():
+        click.echo_via_pager(_generate_output())
+
 
 Screen Clearing
 ---------------