Loader docs update

[phrgab]

Updating documentation and base loader class docstrings for improved information on implementing new loaders.

As suggested in #29

[shum23]

Thanks @phrgab. This is great; I've just suggested a couple of tiny wee edits to the docstring example there. Sort of related, I've noticed that hdf5_explorer is available in base_hdf5_class.py but hasn't been exposed at the top level. Do we want to add e.g.

from peaks.core.fileIO.base_data_classes.base_hdf5_class import BaseHDF5DataLoader

hdf5_explorer = BaseHDF5DataLoader.hdf5_explorer

to peaks/__init__.py so that users call it directly as pks.hdf5_explorer(...)

[phrgab]

Thanks @shum23 for spotting those syntax errors in the examples - fixed now.

On the question of the hdf5 explorer, I'm a little unsure there. On the one hand, I guess this is mostly a helper function for developers to aid in figuring out the sturcture of the file for building new loaders, and so I wonder if this is a function that will really be used by many users of peaks. On the one hand, I agree it is quite hidden at the moment, and I think I have also used it for "live debugging" of loaders during experiments before.

So, I'm OK to add it to the top level if we think it would be sufficiently useful. Alternatively, we could document it, perhaps in the file loaders explanation section, so it is made more clear. Do you have a view there?

[shum23]

Thanks @phrgab. That's fair. I think it's a good idea to add a few words to the explanation section.

[phrgab]

Thanks @shum23, that should be there now

[shum23]

Thanks @phrgab. This is now approved. Please go ahead and merge whenever you're happy with it