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: Software > Tests #17

Closed
lamBOOO opened this issue Nov 8, 2024 · 2 comments
Closed

JOSS: Software > Tests #17

lamBOOO opened this issue Nov 8, 2024 · 2 comments

Comments

@lamBOOO
Copy link
Contributor

lamBOOO commented Nov 8, 2024

Concerning the JOSS review thread.

  • Reference Results in Tests: It would be beneficial if the test suite (e.g., test/Tyson.jl) included comparisons of computed results against reference solutions. This would help in detecting unintended changes in the software's output due to modifications, allowing developers to investigate and address issues promptly.
    • Notably, there are commented-out sections in tests like test/adr.jl that reference XLSX data. It is unclear why these comparisons are commented out. Improving the code quality of the tests by reactivating and ensuring these comparisons work correctly would enhance the reliability of the testing framework.
  • Consistent Naming Conventions: The files within the test folder currently have inconsistent naming conventions regarding the use of underscores and capitalization. Adopting a consistent naming scheme would improve organization and make the test suite easier to navigate and maintain.
@mongibellili
Copy link
Owner

test files are cleaned and commented-out sections are removed.
comparisons of computed results against reference solutions are added for the tyson and the ADR problems.
camelCase is used for file names.

@lamBOOO
Copy link
Contributor Author

lamBOOO commented Jan 17, 2025

@lamBOOO lamBOOO closed this as completed Jan 17, 2025
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