From 20df1a0daf9974f4d2e323549a5122a06f7ec9eb 2013-10-17 21:09:19 From: Brian E. Granger Date: 2013-10-17 21:09:19 Subject: [PATCH] Adding docstring to NotebookHandler.get. --- diff --git a/IPython/html/services/notebooks/handlers.py b/IPython/html/services/notebooks/handlers.py index 37f6f3a..4e2c833 100644 --- a/IPython/html/services/notebooks/handlers.py +++ b/IPython/html/services/notebooks/handlers.py @@ -49,13 +49,11 @@ class NotebookHandler(IPythonHandler): @web.authenticated @json_errors def get(self, path='', name=None): + """Return a Notebook or list of notebooks. + + * GET with path and no notebook name lists notebooks in a directory + * GET with path and notebook name returns notebook JSON """ - GET with path and no notebook lists notebooks in a directory - GET with path and notebook name - - GET get checks if a notebook is not named, an returns a list of notebooks - in the notebook path given. If a name is given, return - the notebook representation""" nbm = self.notebook_manager # Check to see if a notebook name was given if name is None: