Doc tweaks

[fsoubelet]

Went over docs checking for consistency and presence of examples for all APIs.

[codecov]

Codecov Report

Base: 98.42% // Head: 98.50% // Increases project coverage by +0.07% 🎉

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

Additional details and impacted files

@@            Coverage Diff             @@
##           master      #96      +/-   ##
==========================================
+ Coverage   98.42%   98.50%   +0.07%     
==========================================
  Files          46       47       +1     
  Lines        2229     2268      +39     
==========================================
+ Hits         2194     2234      +40     
+ Misses         35       34       -1     

Impacted Files	Coverage Δ
pyhdtoolkit/cpymadtools/coupling.py	97.77% <ø> (ø)
pyhdtoolkit/cpymadtools/errors.py	100.00% <ø> (ø)
pyhdtoolkit/cpymadtools/lhc.py	100.00% <ø> (ø)
pyhdtoolkit/cpymadtools/matching.py	100.00% <ø> (ø)
pyhdtoolkit/cpymadtools/parameters.py	100.00% <ø> (ø)
pyhdtoolkit/cpymadtools/twiss.py	100.00% <ø> (ø)
pyhdtoolkit/cpymadtools/utils.py	100.00% <ø> (ø)
pyhdtoolkit/maths/stats_fitting.py	88.88% <ø> (ø)
pyhdtoolkit/optics/twiss.py	100.00% <ø> (ø)
pyhdtoolkit/plotting/crossing.py	100.00% <ø> (ø)
... and 13 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.