Improve docstrings and methods in src/sets.jl #2099
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
blegat
reviewed
Feb 23, 2023
blegat
reviewed
Feb 23, 2023
blegat
reviewed
Feb 23, 2023
blegat
approved these changes
Feb 27, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Given that the set definitions are perhaps the most important part of MOI, the docstrings have always been a little sparse.
This PR adds examples to them and re-orders some of the methods to break-apart Unions and place the definition directly beneath each set. (The
==definition forIntervalwas 1000 lines away beneathSemiinteger.)Preview link: https://jump.dev/MathOptInterface.jl/previews/PR2099/reference/standard_form/#Sets