DOC: add show_versions() in .md files after 0.20 release #11631
Closed
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
Jul 20, 2018
| import numpy; print("NumPy", numpy.__version__) | ||
| import scipy; print("SciPy", scipy.__version__) | ||
| import sklearn; print("Scikit-Learn", sklearn.__version__) | ||
| import sklearn; sklearn.show_versions() |
There was a problem hiding this comment.
We would need to have separate paragraphs in the documentation for scikit-learn >=0.20 and <0.20, otherwise users with older versions will not report relevant system information at all.
There was a problem hiding this comment.
What would be the proper way to do that in markdown ?
In the .rst docs I have used a .. note:: paragraph to notify it but markdown is less rich and I could not find any other example.
| import numpy; print("NumPy", numpy.__version__) | ||
| import scipy; print("SciPy", scipy.__version__) | ||
| import sklearn; print("Scikit-Learn", sklearn.__version__) | ||
| import sklearn; sklearn.show_versions() |
There was a problem hiding this comment.
Also 2 paragraphs here, depending on the scikit-learn version..
|
ping @aboucaud Please take some time to finish this one ASAP, thanks (It's not recommended to split your work in multiple PRs) |
|
This is intentionally separate.
8000
It's not appropriate to include this in the
README until the latest release includes show_versions.
…On 1 August 2018 at 10:14, Hanmin Qin ***@***.***> wrote:
ping @aboucaud <https://github.com/aboucaud> Please take some time to
finish this one ASAP, thanks (It's not recommended to split your work in
multiple PRs)
—
You are receiving this because you are subscribed to this thread.
Reply to this email directly, view it on GitHub
<#11631 (comment)>,
or mute the thread
<https://github.com/notifications/unsubscribe-auth/AAEz62QwzI-44yPujI7FT37VoY3H8pDAks5uMPLQgaJpZM4VWIYu>
.
|
|
Oops, sorry. |
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.
Following comments on #11522, this PR updates both
CONTRIBUTING.mdandISSUE_TEMPLATE.mdby replacing the version information request with the output ofsklearn.show_versions()that will be implemented in release 0.20.Reference Issues/PRs
Fixes #11522, follows up on #11596.