Skip to content

[docs] Add docstrings for FileFormats models #1798

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
Apr 5, 2022
Merged

[docs] Add docstrings for FileFormats models #1798

Show file tree
Hide file tree
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
5 changes: 5 additions & 0 deletions docs/src/submodules/FileFormats/reference.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,5 +23,10 @@ Functions to help read and write MOI models to/from various file formats. See
```@docs
FileFormats.Model
FileFormats.FileFormat
FileFormats.CBF.Model
FileFormats.LP.Model
FileFormats.MOF.Model
FileFormats.MPS.Model
FileFormats.NL.Model
FileFormats.SDPA.Model
```
12 changes: 6 additions & 6 deletions src/FileFormats/NL/NL.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -112,6 +112,11 @@ mutable struct _VariableInfo
end
end

"""
Model()

Create a new Optimizer object.
"""
mutable struct Model <: MOI.ModelLike
# Store MOI.Name().
name::String
Expand All @@ -131,12 +136,7 @@ mutable struct Model <: MOI.ModelLike
# A vector of the final ordering of the variables.
order::Vector{MOI.VariableIndex}

"""
Model()

Create a new Optimizer object.
"""
function Model(; kwargs...)
function Model()
return new(
"",
_NLExpr(false, _NLTerm[], Dict{MOI.VariableIndex,Float64}(), 0.0),
Expand Down