docstrings.py docstring

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