Doc and import improvement #2

[jlaehne]

Description of the change

Follow up on #47, adresses #38. Starting to continue working on the readers (from the back of the alphabet).

Progress of the PR

• Change implemented (can be split into several points),
• update docstring (if appropriate),
• update user guide (if appropriate),
• add an changelog entry in the upcoming_changes folder (see upcoming_changes/README.rst),
• Check formatting changelog entry in the readthedocs doc build of this PR (link in github checks)
• add tests,
• ready for review.

[codecov]

Codecov Report

Base: 83.39% // Head: 83.47% // Increases project coverage by +0.07% 🎉

Coverage data is based on head (c3d8b1f) compared to base (1fe89dd).
Patch coverage: 100.00% of modified lines in pull request are covered.

Additional details and impacted files

@@            Coverage Diff             @@
##             main      #59      +/-   ##
==========================================
+ Coverage   83.39%   83.47%   +0.07%     
==========================================
  Files          43       49       +6     
  Lines        8348     8388      +40     
  Branches     1896     1896              
==========================================
+ Hits         6962     7002      +40     
  Misses        911      911              
  Partials      475      475              

Impacted Files	Coverage Δ
rsciio/blockfile/_api.py	95.31% <100.00%> (ø)
rsciio/bruker/__init__.py	100.00% <100.00%> (ø)
rsciio/bruker/_api.py	88.27% <100.00%> (ø)
rsciio/docstrings.py	100.00% <100.00%> (ø)
rsciio/semper_unf/__init__.py	100.00% <100.00%> (ø)
rsciio/semper_unf/_api.py	89.58% <100.00%> (ø)
rsciio/sur/__init__.py	100.00% <100.00%> (ø)
rsciio/sur/_api.py	71.42% <100.00%> (ø)
rsciio/tiff/__init__.py	100.00% <100.00%> (ø)
rsciio/tiff/_api.py	88.24% <100.00%> (ø)
... and 6 more

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report at Codecov.
📢 Do you have feedback about the report comment? Let us know in this issue.

[jlaehne]

Working on this PR I realized that plugins have to be loaded by their folder name, which is often not the same as the plugin name:
USID - usid_hdf5
Semper - semper_unf
DigitalSurfSurface - sur

When loading in HyperSpy, the reader can be specified by the plugin name, but when loading an individual plugin one has to use the folder_name, which is not mentioned anywhere in the documentation so far! For example, from rsciio import usid_hdf5.

We may want to give the folders more consistent names that correspond to the default plugin name (capitalization is another question here) and then document the names in the table of supported formats.