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

Optional examples section in JOSS papers #1285

Open
hodgestar opened this issue Oct 23, 2023 · 0 comments
Open

Optional examples section in JOSS papers #1285

hodgestar opened this issue Oct 23, 2023 · 0 comments

Comments

@hodgestar
Copy link

While reviewing the qiskit-dynamics section I thought it might be nice to allow submission to include an examples section within the JOSS paper itself, either as a section near the end or as an appendix.

The advantages of this over examples within the project documentation are:

  • Readers can see the examples straight away without having to navigate through to the project documentation.
  • The examples in the paper can be tailored to JOSS readership (i.e. often industry professionals working in the field) whereas examples in the project documentation often cater to a wider audience.
  • The examples in the paper stay accessible even if the project documentation changes or becomes defunct, so it would allow the JOSS papers to be more useful to readers many decades from now.

Adding examples might made rendering the paper a bit more complex in that authors will want to include code snippets, plots, etc. I don't know which such things are already supported.

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

No branches or pull requests

1 participant