Exported functions with no doc

[blegat]

Edit(odow): updated 31-03-2021

• MOI
• MOIB
• MOIU
• VariableNotOwnedError
• moi_add_constraint
• moi_add_to_function_constant
• parse_SD_constraint
• parse_SD_constraint_expr
• parse_constraint
• parse_constraint_expr
• parse_constraint_head
• parse_one_operator_constraint
• parse_ternary_constraint
• parse_ternary_variable
• parse_variable
• variable_type
• vectorize

Script

deprecated = [
    :getdual,
    :getobjectivebound,
    :getobjectivevalue,
    :getvalue,
    :linearterms,
    :numnlconstr,
    :numvar,
    :set_coefficient,
    :set_parameter,
    :set_parameters,
    :setlowerbound,
    :setupperbound,
    :setvalue,
    :solve,
    :with_optimizer,
    :writeLP,
    :writeMPS,
]
for name in filter(n -> !(n in deprecated), names(JuMP))
    f = getfield(JuMP, name)
    s = Base.Docs.doc(f)
    if s.content[1].content[1] == "No documentation found."
        println(" - [ ] `", name, "`")
    end
end

[blegat]

Isn't the 1.0 milestone more appropriate ? This is not a regression from v0.18

[mlubin]

Of these, I'd say that only index and optimizer_index need to be documented for 0.19. The rest are not that essential for typical usage.

[odow]

With #2731 the list is now

• MOI
• MOIB
• MOIU
• parse_SD_constraint
• parse_SD_constraint_expr
• parse_constraint
• parse_constraint_expr
• parse_constraint_head
• parse_one_operator_constraint
• parse_ternary_constraint
• parse_ternary_variable
• parse_variable
• vectorize

The parse_ methods can be covered by #2236
The MOI structs can be covered by #1789

Therefore, I'm going to close this issue.