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] issues with documentation #2

Closed
hbaniecki opened this issue Oct 13, 2023 · 2 comments
Closed

[joss review] issues with documentation #2

hbaniecki opened this issue Oct 13, 2023 · 2 comments

Comments

@hbaniecki
Copy link

related to openjournals/joss-reviews#5873

  1. Documentation https://pudu-py.github.io/pudu/definitions.html on Importance/Speed/Synergy seems sparse and has no references to relevant literature
  2. Examples in documentation should show outputs of the executed code, e.g. plots, could also use more description to guide users
@enricgrau
Copy link
Collaborator

@hbaniecki Thank you for opening this issue. Regarding your observations:

  1. We have improved the definitions section. However, as these are methodologies that we are introducing, we have struggled to add additional references to them. We hope that considering the new focus of the manuscript and library regarding spectroscopic data those definitions make more sense. Despite this, we are happy to look deeper into the matter if you believe this is paramount for the publication.
  2. We now show an improved examples section adding the output images and more context to each example.

@hbaniecki
Copy link
Author

Thanks for clarifying that this methodology is introduced here

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

2 participants