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.

Sign up for GitHub

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

Jump to bottom

[Request] Documentation: Additional API docs - short descriptions #152

Closed
Deech08 opened this issue Aug 22, 2020 · 0 comments · Fixed by #154
Closed

[Request] Documentation: Additional API docs - short descriptions #152

Deech08 opened this issue Aug 22, 2020 · 0 comments · Fixed by #154

Comments

@Deech08
Copy link

Deech08 commented Aug 22, 2020

As part of JOSS Review openjournals/joss-reviews#2554

Many/most modules in the subpackages have short descriptions of their functionality already, but some do not.
For example desk.fitting.dusty_fit.fit_single_source just says "short description" which I think may have just been filler text.

Another is desk.outputs.parameter_ranges.create_par

and a few in desk.set_up_package
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Added doc strings where they were missing in set_up package. s-goldman/Dusty-Evolved-Star-Kit
1 participant
@Deech08