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: Functionality documentation #328

Closed
wcjochem opened this issue Sep 4, 2024 · 0 comments · Fixed by #332
Closed

JOSS Review: Functionality documentation #328

wcjochem opened this issue Sep 4, 2024 · 0 comments · Fixed by #332
Assignees
Labels
JOSS Joss paper issues

Comments

@wcjochem
Copy link

wcjochem commented Sep 4, 2024

Functionality documentation: Is the core functionality of the software documented to a satisfactory level (e.g., API method documentation)?

I feel the package would benefit from more fully documented functions. While there is a large collection of vignettes, the individual functions have only a minimum template of documentation with argument names and a 1 sentence description. Given that all the functions in the package expect specific formats and types of inputs, I would expect that the type of arguments would be in the documentation. Further expanding the parts of the return values (i.e. more detail than just "list") would also help users.

openjournals/joss-reviews#7047

@mnky9800n mnky9800n added the JOSS Joss paper issues label Sep 9, 2024
@aabelean aabelean linked a pull request Sep 23, 2024 that will close this issue
3 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
JOSS Joss paper issues
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants