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

Adding an example usage to documentation #31

Closed
matt-graham opened this issue May 22, 2024 · 2 comments
Closed

Adding an example usage to documentation #31

matt-graham opened this issue May 22, 2024 · 2 comments
Labels
documentation Improvements or additions to documentation

Comments

@matt-graham
Copy link
Contributor

Raising as part of JOSS review openjournals/joss-reviews/issues/6713

It would help users to have one or more example sin the documentation (or top-level README) of using simdec to compute sensitivity indices / visualize the results. This could potentially use the same data already used in the tests.

@tupui tupui added the documentation Improvements or additions to documentation label May 22, 2024
@tupui
Copy link
Member

tupui commented May 30, 2024

Closing in favour of #34

@tupui tupui closed this as completed May 30, 2024
@matt-graham
Copy link
Contributor Author

Just to note that having an example usage in the documentation (not the JOSS paper) is a specific requirement JOSS reviewers are asked to check in their checklist

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

If the intention of closing this in favour of #34 is that you'll still include an example usage in the documentation (of reproducing the figure from JOSS paper) that's fine but otherwise I would say this should be reopened.

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

No branches or pull requests

2 participants