Commit e226b66f authored by Eric Pellegrini's avatar Eric Pellegrini
Browse files

fixed buggy docstrings

parent f087b422
......@@ -35,8 +35,8 @@ def _openHDFFile(filename):
:type hdfSource: str
The file can be a path to a *true* HDF file or to a file in which the HDF contents has been dumped into.
:raises: :class:`TypeError`: if the input is not a str
:raises: :class:`IOError`: if the path is not valid or could not be opened through h5py API
:raises: :class:`TypeError` if the input is not a str
:raises: :class:`IOError` if the path is not valid or could not be opened through :mod:`h5py` API
"""
hdf = None
......@@ -178,8 +178,10 @@ class HDFViewer(widgets.Accordion):
def _onSelectDataset(self, change):
"""A callable that is called when a new dataset is selected
#Traitlet-events>`__ for more information
See `here <https://ipywidgets.readthedocs.io/en/stable/examples/Widget%20Events.html
See `here <https://ipywidgets.readthedocs.io/en/stable/examples/Widget%20Events.html#Traitlet-events>`__ for more information
:param change: the state of the traits holder
:type change: dict
"""
idx = change["new"]
......
......@@ -56,8 +56,7 @@ class PathSelector(object):
"""Getter for the file browser widget
:return: the file browser widget
# Accordion-and-Tab-use-selected_index,-not-value>`_
:rtype: `ipywidgets.Accordion <https://ipywidgets.readthedocs.io/en/stable/examples/Widget%20List.html
:rtype: `ipywidgets.Accordion <https://ipywidgets.readthedocs.io/en/stable/examples/Widget%20List.html# Accordion-and-Tab-use-selected_index,-not-value>`_
"""
return self._widget
......@@ -65,8 +64,10 @@ class PathSelector(object):
def _onUpdate(self, change):
"""A callable that is called when a new entry of the file browser is clicked
# Traitlet-events>`_ for more information
See `here <https://ipywidgets.readthedocs.io/en/stable/examples/Widget%20Events.html
See `here <https://ipywidgets.readthedocs.io/en/stable/examples/Widget%20Events.html# Traitlet-events>`__ for more information
:param change: the state of the traits holder
:type change: dict
"""
if len(change['new']) > 0:
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment