search

spacetelescope / exovetter

Exoplanet vetting
https://exovetter.readthedocs.io
BSD 3-Clause "New" or "Revised" License
6 stars 5 forks source link

DOC: Improve user-facing documentation #49

Closed pllim closed 3 years ago

pllim commented 3 years ago

As requested by @mustaric .

TODO

codecov[bot] commented 3 years ago

Codecov Report

Merging #49 (f31330d) into master (cfe722b) will not change coverage. The diff coverage is 100.00%.

Impacted file tree graph

@@           Coverage Diff           @@
##           master      #49   +/-   ##
=======================================
  Coverage   80.75%   80.75%           
=======================================
  Files          18       18           
  Lines        1195     1195           
=======================================
  Hits          965      965           
  Misses        230      230
Impacted Files Coverage Δ
exovetter/model.py 90.32% <ø> (ø)
exovetter/vetters.py 86.13% <100.00%> (ø)

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 cfe722b...2ce3368. Read the comment docs.

pllim commented 3 years ago

Currently, the rendered API doc for vetters.py is wrong due to #54

mustaric commented 3 years ago

The rendered version of this looks good. There are places where I really should write better documentation about what each of these vetters do. I didn't see anything wrong, it is just very terse. I'd say go ahead and merge when you are ready.

pllim commented 3 years ago

Okay, I merged it. Thanks for the review! I'll continue in a separate PR after #54 is resolved.