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] Explicitly states what problems the package aims to solve in the docs #295

Closed
damar-wicaksono opened this issue Aug 22, 2023 · 1 comment
Labels
documentation Improvements or additions to documentation JOSS All issues related to the JOSS paper submission
Milestone

Comments

@damar-wicaksono
Copy link
Owner

Following a feedback on the JOSS submission review, the docs should explicitly state what problems the package aims to solve in the docs. I think such a statement should appear in the landing page of the docs.

@damar-wicaksono damar-wicaksono added documentation Improvements or additions to documentation JOSS All issues related to the JOSS paper submission labels Aug 22, 2023
damar-wicaksono added a commit that referenced this issue Aug 24, 2023
- A statement of need for UQTestFuns is made more explicit in
  the landing page with a link to a more detailed discussion.
- Minor edit on the "About UQ Test Functions" edit.
- Fix Issue #289: remove an unnecessary sentence.
- Fix Issue #288: fix missing subscript in a notation.
damar-wicaksono added a commit that referenced this issue Aug 24, 2023
Fix Issue #295: Be more explicit about the need for UQTestFuns.
@damar-wicaksono damar-wicaksono added this to the 0.4.1 Release milestone Aug 24, 2023
@damar-wicaksono
Copy link
Owner Author

This issue has been resolved by PR #300. A paragraph has been added on the landing page of the docs with a link to more detailed discussion regarding the package motivation.

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 JOSS All issues related to the JOSS paper submission
Projects
None yet
Development

No branches or pull requests

1 participant