search

sunpy / sunpy-soar

A sunpy plugin for accessing data in the Solar Orbiter Archive (SOAR).
https://docs.sunpy.org/projects/soar/
BSD 2-Clause "Simplified" License
17 stars 11 forks source link

Update README.rst #30

Closed nabobalis closed 2 years ago

nabobalis commented 2 years ago

Fixes https://github.com/sunpy/sunpy-soar/issues/29#issuecomment-1128193327

Direct copy of the changelog from the release page.

codecov-commenter commented 2 years ago

Codecov Report

Merging #30 (7f4ea9e) into main (55549bc) will not change coverage. The diff coverage is n/a.

@@           Coverage Diff           @@
##             main      #30   +/-   ##
=======================================
  Coverage   97.68%   97.68%           
=======================================
  Files           4        4           
  Lines         173      173           
=======================================
  Hits          169      169           
  Misses          4        4

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 55549bc...7f4ea9e. Read the comment docs.

nabobalis commented 2 years ago

I can edit this myself later today if that's easier, but it would be nice to stick to the current style and remove the dev-only changes (tests/pre-commit) and add a short example for the path string interpolation (I don't think that phrase will mean much to users)

Up to you, I can have a go now.

dstansby commented 2 years ago

Thanks a lot!