DOC details on the use of xfail_checks #16968
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
rth
reviewed
Apr 20, 2020
doc/developers/develop.rst
Outdated
Comment on lines
526
to
529
| Of all tags, the usage of this one is highly subject to change because we | ||
| are trying to make it more flexible in the future. Don't use this unless | ||
| you have a *very good* reason, and be prepared for breaking changes in | ||
| the future. |
There was a problem hiding this comment.
Suggested change
| Of all tags, the usage of this one is highly subject to change because we | |
| are trying to make it more flexible in the future. Don't use this unless | |
| you have a *very good* reason, and be prepared for breaking changes in | |
| the future. | |
| Warning: the API of this tag is likely to change in v0.24 in a backward compatible way. |
I don't agree with recommending not to use it. Yes, the API may change in the future (but we are not even 100% sure), stating it and letting users decide if they are willing to make the migration for v0.24 is enough IMO.
There was a problem hiding this comment.
OK I see "Don't use this unless you have a very good reason." was there before, we can leave it then.
There was a problem hiding this comment.
Though yeah the "don't use this" is more about "be careful about diverting from strict compatibility". I'll reorder
gio8tisu
pushed a commit
to gio8tisu/scikit-learn
that referenced
this pull request
May 15, 2020
viclafargue
pushed a commit
to viclafargue/scikit-learn
that referenced
this pull request
Jun 26, 2020
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.
Basically addresses #16890 (comment)
CC @rth @thomasjpfan
Might need an update depending on the outcome of #16963