From cd931c51124eb44b8b49c4e1f3f2e90dc42c16c6 Mon Sep 17 00:00:00 2001
From: David Halter <davidhalter88@gmail.com>
Date: Tue, 5 Feb 2013 23:25:12 +0100
Subject: [PATCH] docstrings.py docstring

---
 jedi/docstrings.py | 13 ++++++++++++-
 1 file changed, 12 insertions(+), 1 deletion(-)

diff --git a/jedi/docstrings.py b/jedi/docstrings.py
index 3028c19d..00da11aa 100644
--- a/jedi/docstrings.py
+++ b/jedi/docstrings.py
@@ -1,4 +1,15 @@
-""" Processing of docstrings, which means parsing for types. """
+"""
+Docstrings are another source of information for functions and classes.
+:mod:`dynamic` tries to find all executions of functions, while the docstring
+parsing is much easier. There are two different types of docstrings that |jedi|
+understands:
+
+- Sphinx
+- Epidoc
+
+For example, the sphinx annotation ``:type foo: str`` clearly states that the
+type of ``foo`` is ``str``.
+"""
 
 import re