[JOSS] Documentation #676

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

Closed

isdanni opened this issue Sep 26, 2023 · 1 comment · Fixed by #677

isdanni commented Sep 26, 2023

Linking openjournals/joss-reviews#5848 to track review progress.

Just one very minor change:

A statement of need: Do the authors clearly state what problems the software is designed to solve and who the target audience is?

Maybe add a few sentences to https://jonescompneurolab.github.io/hnn-core/stable/index.html after "This is a leaner and cleaner version of the code based off the HNN repository."? Something like the About section in the GitHub page. Direct copy and paste works too.

rythorpe mentioned this issue

[MRG] DOC: add 'About' section to README.rst #677

Merged

jasmainak closed this as completed in #677

Contributor

rythorpe commented Oct 3, 2023

Thanks for the feedback @isdanni! We've implemented your suggestion, but feel free to reopen this issue if you feel we didn't address it adequately.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment