Skip to content

[JOSS Review] Minor typos / wording suggestions #802

Closed

Description

@tmigot

Connected to openjournals/joss-reviews#10630

Minor typos / wording suggestions

Here are some writing suggestions for the JOSS paper.

  • Line 52:
    In contrast with InfiniteOpt.jl that is designed...
    → In contrast to InfiniteOpt.jl, which is designed...

  • Line 54:
    Besides, contributing to general-purpose NLP modeling frameworks...
    → Moreover, contributing to general-purpose NLP modeling frameworks...

  • Line 57:
    ...shooting methods based on Pontryagin’s Maximum Principle and that heavily rely...
    → ...shooting methods based on Pontryagin’s Maximum Principle, which heavily rely...

  • Line 74:
    Direct method tools
    → Direct-method tools

  • Line 75:
    Strong direct method implementations:
    → Strong direct-method implementations:

  • Line 87:
    PDE’s
    → PDEs

  • Line 121:
    arbitrary user defined functions
    → arbitrary user-defined functions

  • Line 146:
    Non-regression on complex problems is increasingly driven by OptimalControlProblems.jl, used as a curated problem bank.
    → Regression testing on complex optimal control instances is increasingly supported by OptimalControlProblems.jl, which serves as a curated problem bank.

  • Line 162:
    Both approaches resort to iterative solvers...
    → Both approaches rely on iterative solvers...

  • Line 163:
    may converge or not, e.g. depending on the initial guess.
    → may or may not converge, e.g., depending on the initial guess.

  • Line 181:
    The package serves educational purposes through Tutorials.jl covering topics...
    → The package also serves educational purposes through Tutorials.jl, which covers topics...

  • Line 190:
    with contributions from multiple developers across the control-toolbox ecosystem packages
    → with contributions from multiple developers across the control-toolbox ecosystem

Activity

  1. jbcaillau commented on Jul 27, 2026

    @jbcaillau
    Member

    Thank you @tmigot for this careful reading. All 12 suggestions have been accepted and applied as proposed in #813 (draft PR into the joss branch). Point-by-point below; note that your line numbers refer to the rendered PDF, so we also give the corresponding joss/paper.md source line.


    1. Line 52 (paper.md L57) — ✅ applied

    In contrast with InfiniteOpt.jl that is designed... → In contrast to InfiniteOpt.jl, which is designed...

    Now reads: "In contrast to InfiniteOpt.jl, which is designed as an extension of JuMP.jl, our package provides a modeler-agnostic approach…"

    2. Line 54 (paper.md L57) — ✅ applied

    Besides, contributing to... → Moreover, contributing to...

    3. Line 57 (paper.md L57) — ✅ applied

    ...Pontryagin's Maximum Principle and that heavily rely... → ...Pontryagin's Maximum Principle, which heavily rely...

    Now reads: "…these tools lack native support for shooting methods based on Pontryagin's Maximum Principle, which heavily rely on differential geometric primitives."

    4. Line 74 (paper.md L67) — ✅ applied

    Direct method tools → Direct-method tools

    5. Line 75 (paper.md L67) — ✅ applied

    Strong direct method implementations: → Strong direct-method implementations:

    6. Line 87 (paper.md L69) — ✅ applied

    PDE's → PDEs

    7. Line 121 (paper.md L85) — ✅ applied

    arbitrary user defined functions → arbitrary user-defined functions

    8. Line 146 (paper.md L89) — ✅ applied

    Non-regression on complex problems is increasingly driven by... → Regression testing on complex optimal control instances is increasingly supported by...

    Adopted verbatim; the existing hyperlink on OptimalControlProblems.jl is preserved. Your phrasing is clearer than ours — "non-regression" was a Gallicism on our part.

    9. Line 162 (paper.md L97) — ✅ applied

    Both approaches resort to iterative solvers... → Both approaches rely on iterative solvers...

    10. Line 163 (paper.md L97) — ✅ applied

    may converge or not, e.g. depending on the initial guess. → may or may not converge, e.g., depending on the initial guess.

    Applied including the comma after e.g.; the source keeps its *e.g.* italic markup, so the sentence now reads "…may or may not converge, e.g., depending on the initial guess."

    11. Line 181 (paper.md L107) — ✅ applied

    The package serves educational purposes through Tutorials.jl covering topics... → The package also serves educational purposes through Tutorials.jl, which covers topics...

    Applied; the hyperlink on Tutorials.jl is preserved.

    12. Line 190 (paper.md L109) — ✅ applied

    ...across the control-toolbox ecosystem packages → ...across the control-toolbox ecosystem


    The updated PDF is regenerated automatically by our Compile JOSS paper workflow and will be visible on the PR branch. Your other two issues (#803 and #805) are being handled separately.

  2. ocots commented on Aug 1, 2026

    @ocots
    Member

    @tmigot Merged in #762.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

No labels
No labels

Type

No type

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions