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

Expand documentation #168

Closed
musoke opened this issue Jan 12, 2024 · 0 comments
Closed

Expand documentation #168

musoke opened this issue Jan 12, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation
Milestone
JOSS review

Comments

@musoke
Copy link
Owner

musoke commented Jan 12, 2024 •
edited
Loading

openjournals/joss-reviews#6035 (comment):

IMHO the package's documentation deserves a bit more content to highlight its functionality and context. Maybe you could consider adding a bit more explanation on what your package does, and maybe a little quickstart section would help to get in touch with the code

openjournals/joss-reviews#6035 (comment):

I think the API docs are a little on the light side, most of the "how do I use this package" stuff seems to be contained in the notebooks. Maybe another page or so on general use would be nice. Still seems like more than PyUltraLight though :) I'm not in this domain, so it's hard for me to say if some of the use is obvious, but I thought I'd mention it anyway.
@musoke musoke added this to the JOSS submission milestone Jan 12, 2024
@musoke musoke added the documentation Improvements or additions to documentation label Jan 12, 2024
musoke added a commit that referenced this issue Apr 12, 2024
@musoke
doc: Add overview of a simple simulation
3d70f37 
Fixes: #168
musoke added a commit that referenced this issue Apr 12, 2024
@musoke
doc: Expand intro describing what UltraDark does
f24b07a 
Fixes: #175
Related: #168
musoke added a commit that referenced this issue Apr 12, 2024
@musoke
doc: Expand intro describing what UltraDark does
94669b2 
Fixes: #175
Related: #168
musoke added a commit that referenced this issue Apr 12, 2024
@musoke
doc: Expand intro describing what UltraDark does
68f2cc2 
Fixes: #175
Related: #168
@musoke musoke closed this as completed in e770ad3 Apr 12, 2024
musoke added a commit that referenced this issue Apr 12, 2024
@musoke
doc: Expand intro describing what UltraDark does
02387d1 
Fixes: #175
Related: #168
musoke added a commit that referenced this issue Apr 13, 2024
@musoke
doc: Clarify many docstrings
1bd263f 
Clarify many of the docstrings in the package.

Document of the fields of the structs defined.

Add docstrings to the modules defined.  These are nice are section
headers in the rendered docs.

Fixes: #185

Related: #168
musoke added a commit that referenced this issue Apr 13, 2024
@musoke
doc: Move Config and Output to own pages
88e5f49 
The docstrings for `UltraDark.Config` and `UltraDark.Output` are
commingled and unclear.  Move them to their own pages for clarity.

Related: #168
musoke added a commit that referenced this issue Apr 13, 2024
@musoke
doc: Clarify many docstrings
aa9a5ee 
Clarify many of the docstrings in the package.

Document of the fields of the structs defined.

Add docstrings to the modules defined.  These are nice are section
headers in the rendered docs.

Fixes: #185

Related: #168
musoke added a commit that referenced this issue Apr 13, 2024
@musoke
doc: Move Config and Output to own pages
3965b3a 
The docstrings for `UltraDark.Config` and `UltraDark.Output` are
commingled and unclear.  Move them to their own pages for clarity.

Related: #168
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
JOSS review
Development

No branches or pull requests
1 participant
@musoke