JOSS: Software > General

[lamBOOO]

Concerning the JOSS review thread.

• Remove Empty Files: Files such as .github/workflow are empty and should be removed.
• Clean Up Redundant Directories: The build folder appears to be a partial copy of src. If it is unnecessary, it should be removed.
• Improve Documentation: Not all functions are documented with docstrings. Comprehensive documentation would enhance usability.
• Eliminate Unnecessary Comments: The code contains many comments that may not be needed, for example, in tests/results_systems.jl. Removing them can improve code readability.
• Simplify Build Scripts: The docs/make.jl file contains unnecessary code, such as run(cp -r "C:/Users/belli/.julia/dev/QuantizedSystemSolver/docs/build/*"). This should be cleaned up.
• Remove Unnecessary Files:
  • lcov.info
  • src/dense/NL_integrators/workspace.code-workspace
  • Please review the repository thoroughly to remove files that are not relevant to users.
• Standardize Directory Naming: Some folders within src use uppercase letters while others use lowercase. Consistent naming conventions should be applied.

[mongibellili]

Thank you for your time:

• redundant and unnecessary folders and files are removed
• unnecessary comments inside files are removed
• files and folders are renamed to follow the camelCase style
• all functions are now documented with docstrings

[lamBOOO]

✅