Marked show_toolbar as experimental.

jdavidheiser · Feb 16, 2016 · f3f7935 · f3f7935
1 parent 9f9c5e0
commit f3f7935
Show file tree

Hide file tree

Showing 3 changed files with 34 additions and 11 deletions.
diff --git a/README.rst b/README.rst
@@ -29,6 +29,10 @@ Demo
 See the demo by viewing `qgrid_demo.ipynb
 <http://nbviewer.jupyter.org/gist/TimShawver/2600c6648c6aaccaf3bf>`_ in nbviewer.
 
+API Documentation
+-----------------
+API documentation is hosted on `readthedocs <http://qgrid.readthedocs.org/en/latest/>`_.
+
 Installation
 ------------
 

diff --git a/docs/index.rst b/docs/index.rst
@@ -3,8 +3,26 @@
    You can adapt this file completely to your liking, but it should at least
    contain the root `toctree` directive.
 
-qgrid API Documentation
-=================================
+Qgrid API Documentation
+=======================
+
+Qgrid is an `IPython widget <https://github.com/ipython/ipywidgets>`_ which uses
+`SlickGrid <https://github.com/mleibman/SlickGrid>`_ to render `pandas <https://github.com/pydata/pandas>`_ DataFrames
+within a `Jupyter notebook <https://github.com/jupyter/notebook>`_.
+
+Other qgrid resources
+--------------------
+
+This page hosts only the API docs for the project.  You might also be interested in these other qgrid-related
+resources:
+
+`qgrid on GitHub <https://github.com/quantopian/qgrid>`_
+  This is where you'll find the source code and the rest of the documentation for the project, including the
+  instructions for installing and running qgrid.
+
+`qgrid demo on nbviewer <http://nbviewer.jupyter.org/gist/TimShawver/2600c6648c6aaccaf3bf>`_
+  See a demo of qgrid in your browser without installing anything.  The functionality of qgrid is somewhat limited
+  in this environment, but it'll give you an idea of how the grid will look and feel when you install it locally.
 
 :mod:`qgrid` Module
 -------------------

diff --git a/qgrid/grid.py b/qgrid/grid.py
@@ -124,16 +124,13 @@ def set_grid_option(optname, optvalue):
     defaults.grid_options[optname] = optvalue
 
 
-def show_grid(data_frame, show_toolbar=False, remote_js=None, precision=None,
-              grid_options=None):
+def show_grid(data_frame, remote_js=None, precision=None, grid_options=None,
+              show_toolbar=False):
     """
     Main entry point for rendering DataFrames as SlickGrids.
 
     Parameters
     ----------
-    show_toolbar: bool
-        Whether to show a toolbar with options for adding/removing rows and
-        exporting the widget to a static view.
     remote_js : bool
         Whether to load slickgrid.js from a local filesystem or from a
         remote CDN.  Loading from the local filesystem means that SlickGrid
@@ -145,10 +142,14 @@ def show_grid(data_frame, show_toolbar=False, remote_js=None, precision=None,
         values.  If unset, we use the value of
         `pandas.get_option('display.precision')`.
     grid_options : dict
-        Options to use when creating javascript SlickGrid instances.  See
-        the `SlickGrid documentation <https://github.com/mleibman/SlickGrid/wiki/Grid-Options>`_ for
-        information on the available options.  See the Notes section below for
-        the list of options that qgrid sets by default.
+        Options to use when creating javascript SlickGrid instances.  See the Notes section below for
+        more information on the available options, as well as the default options that qgrid uses.
+    show_toolbar : bool
+        *EXPERIMENTAL* - Whether to show a toolbar with options for adding/removing rows and
+        exporting the widget to a static view.  This feature is marked as experimental because
+        add/remove rows is not fully functional yet.  The export feature should work fine,
+        so it's technically not experimental.  Most people will have no need for it though, so
+        I don't mind keeping it buried here under the experimental label.
 
     Notes
     -----