Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

DOC: Improve user-facing documentation #49

Merged
merged 4 commits into from
Mar 15, 2021

Conversation

pllim
Copy link
Collaborator

@pllim pllim commented Feb 26, 2021

As requested by @mustaric .

TODO

  • Re-organize sections.
  • Fix formatting: Heading level uneven, narrative + API mix hard to read.
  • Improve docstring.

@pllim pllim added this to In progress in DDRF 2020 Feb 26, 2021
@pllim pllim added documentation Improvements or additions to documentation enhancement New feature or request labels Feb 26, 2021
Copy link
Collaborator

@mustaric mustaric left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks like a really good start. I don't have strong opinions on the organization, so if you like it, then I think we can go for it. If you have places where you are unsure we could discuss it.

@codecov
Copy link

codecov bot commented Mar 12, 2021

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
Copy link
Collaborator Author

pllim commented Mar 12, 2021

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

@pllim pllim marked this pull request as ready for review March 12, 2021 21:07
@mustaric
Copy link
Collaborator

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 pllim merged commit ca48e68 into spacetelescope:master Mar 15, 2021
@pllim pllim deleted the api-docstring branch March 15, 2021 15:04
@pllim
Copy link
Collaborator Author

pllim commented Mar 15, 2021

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

@pllim pllim moved this from In progress to Done in DDRF 2020 Mar 15, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
DDRF 2020
  
Done
Development

Successfully merging this pull request may close these issues.

None yet

2 participants