Skip to content

[docs] add developer docs for unset_ methods #3990

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
odow merged 2 commits into from
May 5, 2025
Merged

[docs] add developer docs for unset_ methods #3990

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7646911
[docs] add developer docs for unset_ methods
odow May 5, 2025
583f4cc
Update docs/src/developers/conventions.md
odow May 5, 2025
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
24 changes: 24 additions & 0 deletions docs/src/developers/conventions.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,3 +35,27 @@ get_attribute(c, MOI.ConstraintDualStart())
set_attribute(c, MOI.ConstraintDualStart(), [2.0, -1.0, 1.0])
dual_start_value(c)
```

## `unset_` methods

There are a variety of attributes in JuMP and MOI that can be "set" and "unset."
For example, there is [`MOI.Silent`](@ref), and the corresponding
[`set_silent`](@ref) and [`unset_silent`](@ref).

Note how [`set_silent`](@ref) and [`unset_silent`](@ref) take a single argument
(the model), where `set_silent(model)` corresponds to `MOI.set(model, MOI.Silent(), true)`
and `unset_silent(model)` corresponds to `MOI.set(model, MOI.Silent(), false)`.
We could have instead implemented a single method `set_silent(model, flag::Bool)`
that corresponded to `MOI.set(model, MOI.Silent(), flag)`. Another example is
[`unset_time_limit_sec`](@ref), which is equivalent to
`set_time_limit_sec(model, nothing)`.

We have come to regard the `unset_` design as a mistake, because it leads to a
proliferation of unique function names instead of leveraging Julia's strength
for multiple dispatch.

The existing `unset_` names are retained for backwards compatibility, but, going
forward, provide a single `set_` method and document what value type should be
provided to restore the model to the default setting. Thus, we have
[`set_string_names_on_creation`](@ref), but no corresponding
`unset_string_names_on_creation`.
Loading