Skip to content

Add reference to optimizationsolution in the solve docs #1071

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jul 24, 2025
Merged

Add reference to optimizationsolution in the solve docs #1071

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion src/solve.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,9 +43,11 @@ end

"""
```julia
solve(prob::OptimizationProblem, alg::AbstractOptimizationAlgorithm, args...; kwargs...)
solve(prob::OptimizationProblem, alg::AbstractOptimizationAlgorithm, args...; kwargs...)::OptimizationSolution
Copy link
Contributor

@github-actions github-actions bot Jul 24, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[JuliaFormatter] reported by reviewdog 🐶

Suggested change
solve(prob::OptimizationProblem, alg::AbstractOptimizationAlgorithm, args...; kwargs...)::OptimizationSolution
solve(prob::OptimizationProblem, alg::AbstractOptimizationAlgorithm,
args...; kwargs...)::OptimizationSolution

```

For information about the returned solution object, refer to the documentation for [OptimizationSolution](@ref)

## Keyword Arguments

The arguments to `solve` are common across all of the optimizers.
Expand Down
Loading