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

[JOSS Review] Complete user guide and existing documentation pages #4

Open
matthewfeickert opened this issue Apr 17, 2023 · 0 comments

Comments

@matthewfeickert
Copy link

For the JOSS documentation check of openjournals/joss-reviews#4170

Example usage: Do the authors include examples of how to use the software (ideally to solve real-world analysis problems).

Mostly yes, but there are multiple instances of "todo"s in the user guide that should be filled in.

Though at the release we are reviewing (v0.4.0) the user guide didn't exist yet, so I don't think that can really be held against the authors, so I don't think this should impact the publication process.

Also there are some pages in the docs left blank:

Filling these out in detail would be beneficial, as the rest of the docs are strong. 👍

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant