Skip to content

Commit aaf6fc8

Browse files
committed
Fix python doc
1 parent fe66dfb commit aaf6fc8

File tree

1 file changed

+4
-3
lines changed

1 file changed

+4
-3
lines changed

dataikuapi/dss/project.py

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -833,11 +833,12 @@ def list_jupyter_notebooks(self, active=False, as_type="object"):
833833
"""
834834
List the jupyter notebooks of a project.
835835

836-
:param bool as_type: How to return the list. Supported values are "names" and "objects".
836+
:param bool as_type: How to return the list. Supported values are "listitems" and "objects".
837837
:param bool active: if True, only return currently running jupyter notebooks.
838838

839-
:returns: The list of the notebooks. If "as_type" is "names", each one as a string, if "as_type" is "objects", each one as a :class:`dataikuapi.dss.notebook.DSSJupyterNotebook`
840-
:rtype: list of :class:`dataikuapi.dss.notebook.DSSJupyterNotebook` or list of String
839+
:returns: The list of the notebooks. If "as_type" is "listitems", each one as a :class:`dataikuapi.dss.notebook.DSSJupyterNotebookListItem`,
840+
if "as_type" is "objects", each one as a :class:`dataikuapi.dss.notebook.DSSJupyterNotebook`
841+
:rtype: list of :class:`dataikuapi.dss.notebook.DSSJupyterNotebook` or list of :class:`dataikuapi.dss.notebook.DSSJupyterNotebookListItem`
841842
"""
842843
notebook_items = self.client._perform_json("GET", "/projects/%s/jupyter-notebooks/" % self.project_key, params={"active": active})
843844
if as_type == "listitems" or as_type == "listitem":

0 commit comments

Comments
 (0)