Skip to content

[General] JOSS Review comments on the repo #805

Description

@tmigot

Connected with openjournals/joss-reviews#10630

Here are a few comments on the repo. I also opened a #804 with minor changes.

Root-level files

  • DOI mismatch: .zenodo.json declares 10.5281/zenodo.13336652 while CITATION.bib and CITATION.cff both declare 10.5281/zenodo.13336563.
  • Spurious deps in Project.toml: Documenter, ADNLPModels, NLPModels, and SolverCore are listed in [deps] but never using/import-ed anywhere in src/. Documenter already has its own environment in docs/Project.toml.
  • README.md basic usage: using NLPModelsIpopt appears with no explanation that it is needed to activate a package extension. A first-time user will not know why it is there or what happens if they omit it.
  • CITATION.cff missing recommended fields: version and date-released are both recommended by the CFF 1.2 spec and used by GitHub's "Cite this repository" feature.

/test

  • test/README.md commands are Unix-only: every example pipes through tee /tmp/test_output.txt. /tmp does not exist on Windows, so the command fails before Julia even starts. Either drop the pipe or replace /tmp with a cross-platform alternative (e.g. a relative path or a temp file via $(mktemp) on Unix and $env:TEMP on Windows).
  • test/README.md uses shell commands instead of Julia-native ones: all examples are julia --project=@. -e '...' one-liners, which require careful shell quoting that varies by platform (single quotes break on Windows cmd, nested double quotes are tricky in PowerShell). It would be simpler and more portable to document the equivalent Julia REPL commands directly, e.g. using Pkg; Pkg.test(test_args=["all"]), which work identically on all platforms.
  • Tests do not run at all on Windows: Pkg.test(test_args=["all"]), Pkg.test(test_args=["suite/reexport/*"]), and plain Pkg.test() all report OptimalControl tests | 0 0.0s. The root cause is likely a path-separator mismatch in CTBase.run_tests: on Windows the glob "suite/*/test_*" discovers files with backslash separators (suite\helpers\test_component_checks), while the matching logic expects forward slashes, so the available-tests list comes back empty and nothing runs regardless of args. This is a blocking bug — the entire test suite is currently non-runnable on Windows via the standard Pkg.test interface.

/docs

  • Spurious dependency in docs/Project.toml: DataFrames is listed in [deps] and [compat] but is never using-ed anywhere in the docs source.

/.github

  • CPU/GPU Julia version inconsistency in CI.yml: the CPU job pins versions: '["1.12"]' while the GPU job uses versions: '["1"]' (latest stable). They should target the same Julia version to avoid silent divergence.

Metadata

Metadata

Assignees

Labels

No labels
No labels

Type

No type

Fields

No fields configured for issues without a type.

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions