Improve documentation and fix docstrings

[tmigot]

• Fix docstring rendering
• Add link to GenericExecutionStats
• Write down NLP/NLS in solvers.md

[Copilot]

Pull request overview

This PR improves documentation across multiple solver files by adding hyperlinks to GenericExecutionStats, fixing docstring formatting issues, and expanding acronyms in the solver documentation table.

Key changes:

• Added clickable markdown links to GenericExecutionStats documentation across all solver files
• Fixed docstring rendering by adding proper line breaks between the opening """ and function signatures
• Expanded NLP/NLS acronyms to their full names in the solvers table

Reviewed changes

Copilot reviewed 7 out of 7 changed files in this pull request and generated 1 comment.

Show a summary per file

File	Description
src/trunkls.jl	Added hyperlink to GenericExecutionStats documentation
src/trunk.jl	Added hyperlink to GenericExecutionStats documentation
src/tronls.jl	Added hyperlink to GenericExecutionStats documentation and fixed two docstring formats with proper line breaks
src/tron.jl	Added hyperlink to GenericExecutionStats documentation, fixed two docstring formats with proper line breaks, and corrected spacing in parameter σ
src/lbfgs.jl	Added hyperlink to GenericExecutionStats documentation
src/fomo.jl	Added hyperlink to GenericExecutionStats documentation
docs/src/solvers.md	Expanded NLP to "Nonlinear Optimization Problem" and NLS to "Nonlinear Least Squares" in the problem types table

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

[github-actions]

Package name	latest	stable
FletcherPenaltySolver
JSOSuite
PartiallySeparableNLPModels
Percival

[github-actions]

Package name	latest	stable
FletcherPenaltySolver
JSOSuite
PartiallySeparableNLPModels
Percival

[tmigot]

Related to #337
The preview is here: https://jso.dev/JSOSolvers.jl/previews/PR339/

@dourouc05 can you have a look at this PR regarding changes you suggested ?
This should cover the first three points. Regardings, Is there a link from the docs to the tutorials (https://jso.dev/tutorials/)? the package Examples's page focuses only on that.

As you have callbacks for every solver, maybe the corresponding explanations could be made into their own section?

Could you expand a bit on what you mean here ? In the docstring of each solver, there is a section regarding callback, for instance https://jso.dev/JSOSolvers.jl/previews/PR339/reference/#JSOSolvers.TronSolver .

[dourouc05]

About the callbacks, here is what I mean:

JSOSolvers.FoSolver

Callback

The callback is called at each iteration. […]

JSOSolvers.FomoSolver

Callback

The callback is called at each iteration. […]

JSOSolvers.LBFGSSolver

Callback

The callback is called at each iteration. […]

It's nearly always the same text, which means that you could have a section that explains that and you could refer to it in each function (instead of having a copy of the same blob everywhere).

[tmigot]

Oh, I see. It's actually a docstring here https://github.com/JuliaSmoothOptimizers/JSOSolvers.jl/blob/main/src%2FJSOSolvers.jl#L14 that we refer in each solver. I will think of a better way

[tmigot]

Oh, I see. It's actually a docstring here https://github.com/JuliaSmoothOptimizers/JSOSolvers.jl/blob/main/src%2FJSOSolvers.jl#L14 that we refer in each solver. I will think of a better way