SciQLop / speasy

Space Physics made EASY! A simple Python package to deal with main Space Physics WebServices (CDA,SSC,AMDA,..)
Other
24 stars 7 forks source link

Documentation update for v0.10 #26

Closed jeandet closed 2 years ago

jeandet commented 2 years ago

Mostly a Documentation rewrite with the following notable changes:

It also:

We should be able to release (0.10.0) now and continue improving documentation on each release.

codecov[bot] commented 2 years ago

Codecov Report

Merging #26 (1930377) into main (27b9e6c) will decrease coverage by 1.36%. The diff coverage is 95.45%.

Impacted file tree graph

@@            Coverage Diff             @@
##             main      #26      +/-   ##
==========================================
- Coverage   86.91%   85.54%   -1.37%     
==========================================
  Files          31       31              
  Lines        1467     1474       +7     
  Branches      209      248      +39     
==========================================
- Hits         1275     1261      -14     
- Misses        130      150      +20     
- Partials       62       63       +1     
Flag Coverage Δ
unittests 85.54% <95.45%> (-1.37%) :arrow_down:

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

Impacted Files Coverage Δ
speasy/products/catalog.py 94.87% <ø> (ø)
speasy/products/dataset.py 96.96% <ø> (+9.09%) :arrow_up:
speasy/products/timetable.py 96.55% <ø> (ø)
speasy/products/variable.py 93.10% <ø> (+1.14%) :arrow_up:
speasy/webservices/amda/__init__.py 100.00% <ø> (ø)
speasy/webservices/amda/inventory.py 96.66% <ø> (ø)
speasy/webservices/ssc/__init__.py 85.71% <60.00%> (-2.35%) :arrow_down:
speasy/__init__.py 90.00% <100.00%> (ø)
speasy/config/__init__.py 95.55% <100.00%> (ø)
speasy/core/__init__.py 95.00% <100.00%> (-2.50%) :arrow_down:
... and 10 more

Continue to review full report at Codecov.

Legend - Click here to learn more Δ = absolute <relative> (impact), ø = not affected, ? = missing data Powered by Codecov. Last update 27b9e6c...1930377. Read the comment docs.

jeandet commented 2 years ago

I've added #33 trivial fix commit to merge all at once.