We read every piece of feedback, and take your input very seriously.
To see all available qualifiers, see our documentation.
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
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.
asimov/docs/source/user-guide/projects.rst
Line 25 in fc2b7c1
Line 30 in fc2b7c1
https://github.com/ligo-asimov/asimov/blob/fc2b7c1b8ea3284a9dc089ec256e186f44e638ea/docs/source/user-guide/monitoring.rst
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.
v0.4.0
Also there are some pages in the docs left blank:
https://github.com/ligo-asimov/asimov/blob/fc2b7c1b8ea3284a9dc089ec256e186f44e638ea/docs/source/configuration.rst
https://github.com/ligo-asimov/asimov/blob/fc2b7c1b8ea3284a9dc089ec256e186f44e638ea/docs/source/asimov-repository.rst
https://github.com/ligo-asimov/asimov/blob/fc2b7c1b8ea3284a9dc089ec256e186f44e638ea/docs/source/code-overview.rst
Filling these out in detail would be beneficial, as the rest of the docs are strong. 👍
The text was updated successfully, but these errors were encountered:
No branches or pull requests
For the JOSS documentation check of openjournals/joss-reviews#4170
Mostly yes, but there are multiple instances of "todo"s in the user guide that should be filled in.
asimov/docs/source/user-guide/projects.rst
Line 25 in fc2b7c1
asimov/docs/source/user-guide/projects.rst
Line 30 in fc2b7c1
https://github.com/ligo-asimov/asimov/blob/fc2b7c1b8ea3284a9dc089ec256e186f44e638ea/docs/source/user-guide/monitoring.rst
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:
https://github.com/ligo-asimov/asimov/blob/fc2b7c1b8ea3284a9dc089ec256e186f44e638ea/docs/source/configuration.rst
https://github.com/ligo-asimov/asimov/blob/fc2b7c1b8ea3284a9dc089ec256e186f44e638ea/docs/source/asimov-repository.rst
https://github.com/ligo-asimov/asimov/blob/fc2b7c1b8ea3284a9dc089ec256e186f44e638ea/docs/source/code-overview.rst
Filling these out in detail would be beneficial, as the rest of the docs are strong. 👍
The text was updated successfully, but these errors were encountered: