wip

Erotemic · Apr 24, 2019 · 12902d8 · 12902d8
1 parent 4bc79ca
commit 12902d8
Show file tree

Hide file tree

Showing 2 changed files with 16 additions and 0 deletions.
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -7,6 +7,10 @@ ProgIter documentation
 .. automodule:: progiter.__init__
    :show-inheritance:
 
+
+.. automodule:: progiter.progiter
+   :show-inheritance:
+
 .. commented out
 .. :members:
 .. :undoc-members:

diff --git a/progiter/__init__.py b/progiter/__init__.py
@@ -1,3 +1,15 @@
+# -*- coding: utf-8 -*-
+"""
+ProgIter is a simple way to indicate progress of an iterative process.
+
+Its basic usage is simple and intuitive. Just wrap a python iterable.
+
+Example:
+    >>> from progiter import ProgIter
+    >>> for item in ProgIter(range(1000000000)):
+    >>>     item  # Do Work
+"""
+from __future__ import unicode_literals
 from .progiter import (ProgIter,)
 
 __version__ = '0.1.1'