[doc] clarify documentation of solvers #1663
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
joaquimg
reviewed
Nov 18, 2021
There was a problem hiding this comment.
Agree with not mandating.
In the first version of a solver, it is very common to start with a readme.
Since the suggestion is looking at those, I bet people will be copy-and-paste'ing. In this case a suggested template would be very nice. I could even be Cbc.jl or other existing solver with a very good readme.
blegat
approved these changes
Nov 18, 2021
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.
Closes #1633
I don't think we want to include out-dated READMEs in the documentation, and I don't think we want to mandate what the README should look like. We can aim for internal consistency without explicitly documenting this.