Added docs to packages that hold same-name modules for better help.

theengineear · theengineear · commit 72039daa7a1a · 2014-05-07T16:16:35.000-07:00
diff --git a/plotly/graph_objs/__init__.py b/plotly/graph_objs/__init__.py
@@ -1,3 +1,45 @@
+"""
+graph_objs
+==========
+
+This package imports definitions for all of Plotly's graph objects. For more
+information, run help(Obj) on any of the following objects defined here...
+
+Defined Objects:
+
+    Data Objects (things that make up your 'Data' list:
+        Bar
+        Box
+        Contour
+        Heatmap
+        Histogram
+        Histogram2d
+        Histogram2dContour
+        Scatter
+
+    Other Objects (everything else):
+
+        Data
+        Annotations
+        Annotation
+        ColorBar
+        Contours
+        ErrorY
+        Figure
+        Font
+        Layout
+        Legend
+        Line
+        Margin
+        Marker
+        Stream
+        Trace
+        XAxis
+        XBins
+        YAxis
+        YBins
+
+"""
 from graph_objs import *
 
 __all__ = ["Data", "Annotations", "Bar", "Box", "Contour", "Heatmap",
diff --git a/plotly/matplotlylib/__init__.py b/plotly/matplotlylib/__init__.py
@@ -1,2 +1,13 @@
+"""
+matplotlylib
+============
+
+This module converts matplotlib figure objects into JSON structures which can
+be understood and visualized by Plotly.
+
+Most of the functionality should be accessed through the parent directory's
+'tools' or 'plotly' modules.
+
+"""
 from . renderer import PlotlyRenderer
 from . mplexporter import Exporter
diff --git a/plotly/plotly/__init__.py b/plotly/plotly/__init__.py
@@ -1,3 +1,27 @@
+"""
+plotly
+======
+
+This module defines functionality that requires interaction between your
+local machine and Plotly. Almost all functionality used here will required a
+verifiable account and an internet connection.
+
+Classes:
+    image
+    Stream
+
+Functions:
+    sign_in
+    iplot
+    plot
+    iplot_mpl
+    plot_mpl
+    get_figure
+    update_plot_options
+    get_plot_options
+    get_credentials
+
+"""
 from plotly import *
 
 __all__ = ["sign_in", "update_plot_options", "get_plot_options",
