Address editor comments#287
Address editor comments#287MohamedLaghdafHABIBOULLAH wants to merge 0 commit intoJuliaSmoothOptimizers:paperfrom
Conversation
There was a problem hiding this comment.
Pull request overview
This pull request addresses editor comments from the JOSS paper review (issue #284), implementing typo corrections, phrasing improvements, and updating package metadata. The changes primarily focus on fixing grammatical issues, improving clarity, and updating authorship information.
Changes:
- Fixed typos and phrasing in paper.md (e.g., "models about" → "models around", "In contrast with" → "In contrast to")
- Added new bibliography entry for ongoing research and updated Project.toml UUID and author list
- Simplified installation instructions in README.md and added contributing guidelines
Reviewed changes
Copilot reviewed 7 out of 8 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| paper/paper.md | Corrected typos and improved phrasing throughout the paper per JOSS review comments |
| paper/paper.bib | Added citation for ongoing research on inexact proximal computations |
| paper/examples/Project.toml | Added LaTeXStrings dependency and path-based source for RegularizedOptimization |
| Project.toml | Changed UUID and expanded author list to include all contributors |
| CITATION.bib | Updated author list to match Project.toml |
| README.md | Changed installation from GitHub URL to package name, added contributing section |
| test/test_allocs.jl | Added warm-up call before allocation measurement for stability |
| src/RegularizedOptimization.jl | Explicitly imported reset! from SolverCore |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
paper/paper.md
Outdated
| **LMTR** and **LM** require the fewest function evaluations, but incur many Jacobian–vector products, and are the slowest in terms of time. | ||
|
|
||
| Ongoing research aims to reduce the number of proximal evaluations. | ||
| Ongoing research aims to reduce the number of proximal evaluations, for instance by allowing inexact proximal computations[@allaire-le-digabel-orban-2025]. |
There was a problem hiding this comment.
Missing space before the citation. There should be a space between "computations" and the citation. The text should read: "inexact proximal computations [@allaire-le-digabel-orban-2025]" (with a space before the [@).
| Ongoing research aims to reduce the number of proximal evaluations, for instance by allowing inexact proximal computations[@allaire-le-digabel-orban-2025]. | |
| Ongoing research aims to reduce the number of proximal evaluations, for instance by allowing inexact proximal computations [@allaire-le-digabel-orban-2025]. |
| kwargs_dict = Dict{Symbol, Any}(a.args[1] => a.args[2] for a in kwargs if a.head == :kw) | ||
| quote | ||
| function g($(argnames...); kwargs_dict...) | ||
| $(Expr(expr.head, argnames..., kwargs...)) # Call the function twice to make the allocated macro more stable |
There was a problem hiding this comment.
The comment says "Call the function twice to make the allocated macro more stable" but the code only calls the function once before the @allocated call. The comment should say "Call the function once before measurement" or similar to accurately describe what the code does. Alternatively, if calling twice is truly the intent, the code should be modified to match.
| $(Expr(expr.head, argnames..., kwargs...)) # Call the function twice to make the allocated macro more stable | |
| $(Expr(expr.head, argnames..., kwargs...)) # Call the function once before measurement to make the @allocated result more stable |
paper/paper.md
Outdated
| ## Support for both exact and approximate Hessian | ||
|
|
||
| In contrast with [ProximalAlgorithms.jl](https://github.com/JuliaFirstOrder/ProximalAlgorithms.jl), [RegularizedOptimization.jl](https://github.com/JuliaSmoothOptimizers/RegularizedOptimization.jl), methods such as **R2N** and **TR** methods support exact Hessians as well as several Hessian approximations of $f$. | ||
| In contrast to [ProximalAlgorithms.jl](https://github.com/JuliaFirstOrder/ProximalAlgorithms.jl), [RegularizedOptimization.jl](https://github.com/JuliaSmoothOptimizers/RegularizedOptimization.jl), methods such as **R2N** and **TR** support exact Hessians as well as several Hessian approximations of $f$. |
There was a problem hiding this comment.
The word "methods" appears twice in this sentence: "methods such as R2N and TR methods". According to issue #284, this should be fixed by removing one instance. The sentence should read: "methods such as R2N and TR support" (without the second "methods").
MohamedLaghdafHABIBOULLAH
force-pushed
the
paper
branch
from
d67afd2 to
83e66ad
Compare
1 participant
284