You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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.
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
The text was updated successfully, but these errors were encountered: