rice-solar-physics / pydrad

Python tools for setting up HYDRAD runs and parsing output
https://pydrad.readthedocs.io
MIT License
4 stars 3 forks source link

Doc fixes #144

Closed wtbarnes closed 2 years ago

wtbarnes commented 3 years ago

Fixes #127 Fixes #40 Fixes #138 Fixes #72 Fixes #73 Fixes #77

This updates all of the docstrings and other documentation to be consistent with sphinx and RTD. It also refactors how the configuration tables are represented in the docs and moves all of the example code to a gallery.

TODO

codecov[bot] commented 3 years ago

Codecov Report

Merging #144 (2cd0d34) into master (4e04e61) will decrease coverage by 2.40%. The diff coverage is 26.86%.

@@            Coverage Diff             @@
##           master     #144      +/-   ##
==========================================
- Coverage   65.44%   63.04%   -2.41%     
==========================================
  Files          10       11       +1     
  Lines         657      690      +33     
==========================================
+ Hits          430      435       +5     
- Misses        227      255      +28     
Impacted Files Coverage Δ
pydrad/configure/configure.py 78.48% <ø> (ø)
pydrad/configure/data/__init__.py 0.00% <0.00%> (ø)
pydrad/visualize/animate.py 20.00% <ø> (ø)
pydrad/visualize/plot.py 15.30% <5.00%> (-0.43%) :arrow_down:
pydrad/configure/util.py 57.89% <33.33%> (-8.78%) :arrow_down:
pydrad/parse/parse.py 71.08% <50.00%> (-0.97%) :arrow_down:

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 4e04e61...2cd0d34. Read the comment docs.