Giters

musoke / UltraDark.jl

Simulations of cosmological scalar fields

Home Page:https://musoke.github.io/UltraDark.jl/

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Expand documentation

musoke opened this issue · comments

commented

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.