Skip to content

Commit 6b50fa0

Browse files
authored
[docs] Add docstrings for FileFormats models (#1798)
1 parent b00d4e0 commit 6b50fa0

File tree

2 files changed

+11
-6
lines changed

2 files changed

+11
-6
lines changed

docs/src/submodules/FileFormats/reference.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,5 +23,10 @@ Functions to help read and write MOI models to/from various file formats. See
2323
```@docs
2424
FileFormats.Model
2525
FileFormats.FileFormat
26+
FileFormats.CBF.Model
27+
FileFormats.LP.Model
28+
FileFormats.MOF.Model
29+
FileFormats.MPS.Model
30+
FileFormats.NL.Model
2631
FileFormats.SDPA.Model
2732
```

src/FileFormats/NL/NL.jl

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -112,6 +112,11 @@ mutable struct _VariableInfo
112112
end
113113
end
114114

115+
"""
116+
Model()
117+
118+
Create a new Optimizer object.
119+
"""
115120
mutable struct Model <: MOI.ModelLike
116121
# Store MOI.Name().
117122
name::String
@@ -131,12 +136,7 @@ mutable struct Model <: MOI.ModelLike
131136
# A vector of the final ordering of the variables.
132137
order::Vector{MOI.VariableIndex}
133138

134-
"""
135-
Model()
136-
137-
Create a new Optimizer object.
138-
"""
139-
function Model(; kwargs...)
139+
function Model()
140140
return new(
141141
"",
142142
_NLExpr(false, _NLTerm[], Dict{MOI.VariableIndex,Float64}(), 0.0),

0 commit comments

Comments
 (0)