Streamline Docstrings

[pauladkisson]

Significant Changes

• Adds pydocstyle to pre-commit to ensure consistent docstring formatting.
• Adds docstrings to all members (modules, classes, methods, functions) without them and makes sure all docstrings are compliant with pydocstyle
• Some minor typo fixes and clarifications here and there

[codecov]

Codecov Report

Merging #235 (2769b8e) into main (f0cec06) will decrease coverage by 0.08%.
The diff coverage is 88.23%.

@@            Coverage Diff             @@
##             main     #235      +/-   ##
==========================================
- Coverage   77.05%   76.98%   -0.08%     
==========================================
  Files          37       37              
  Lines        2724     2724              
==========================================
- Hits         2099     2097       -2     
- Misses        625      627       +2     

Flag	Coverage Δ
unittests	76.98% <88.23%> (-0.08%)	⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

Files Changed	Coverage Δ
src/roiextractors/__init__.py	72.72% <ø> (ø)
src/roiextractors/example_datasets/__init__.py	100.00% <ø> (ø)
src/roiextractors/extraction_tools.py	61.81% <ø> (ø)
src/roiextractors/extractors/caiman/__init__.py	100.00% <ø> (ø)
...actors/extractors/hdf5imagingextractor/__init__.py	100.00% <ø> (ø)
...ctors/hdf5imagingextractor/hdf5imagingextractor.py	82.35% <ø> (ø)
...rs/extractors/memmapextractors/memmapextractors.py	97.14% <ø> (ø)
...xtractors/memmapextractors/numpymemampextractor.py	100.00% <ø> (ø)
...s/extractors/miniscopeimagingextractor/__init__.py	100.00% <ø> (ø)
...iextractors/extractors/numpyextractors/__init__.py	100.00% <ø> (ø)
... and 26 more

📢 Have feedback on the report? Share it here.

[CodyCBakerPhD]

So, this looks good to me now as-is

@pauladkisson Would you like to merge this in directly (and follow-up PR perhaps enhances them to be even more stringent using a better linter) or wait and find a better linter in this PR?

[pauladkisson]

We should merge this directly and follow-up. I still think the numpydoc validation pre-commit is going to be our best bet, but getting it to work properly has proved more complicated than I originally thought. Plus, this PR is already pretty substantial.