[MRG+1] DOC Add libraries.io and changelog links #11298
Merged
Conversation
This file contains 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
jnothman
reviewed
Jun 17, 2018
README.rst
Outdated
| See the `changelog <http://scikit-learn.org/dev/whats_new.html>`__ | ||
| for a history of notable changes to scikit-learn. | ||
|
|
||
| .. The following two lines are duplicated in doc/whats_new.rst |
There was a problem hiding this comment.
I don't think comments like this in a README are appropriate. I'd rather remove this and the following reference to libraries.io. It is sufficient to have in what's new, or perhaps in installation instructions
|
I agree it's not ideal to have those comments to compensate for GitHub's impoverished rst renderer but think the benefit to users of also having the libraries.io link in the README far outweighed the small maintenance cost of having the link duplicated in both places. That said, I have removed the libraries.io link from the README and the associated comments so that this can be merged assuming this PR is now 👍. |
qinhanmin2014
approved these changes
Jun 18, 2018
| @@ -78,6 +78,12 @@ or ``conda``:: | |||
| The documentation includes more detailed `installation instructions <http://scikit-learn.org/stable/install.html>`_. | |||
|
|
|||
|
|
|||
| Changelog | |||
There was a problem hiding this comment.
I think I'm fine with this unrelated change
qinhanmin2014
changed the title
jnothman
approved these changes
Jun 18, 2018
georgipeev
pushed a commit
to georgipeev/scikit-learn
that referenced
this pull request
Jun 20, 2018
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.
The first commit in this PR closes #11287 by adding a "subscribe to releases on libraries.io" link to the "what's new" page:
I also noticed that there is no link to the changelog/what's new page from the https://github.com/scikit-learn/scikit-learn#readme content on GitHub, but I thought there should be: The "what's new" content is often the one thing that upgrading users are looking for, so I think it should be linked to from every top-level page. So the second commit in this PR adds a changelog link to the README that is displayed on GitHub, as well as another "subscribe to releases" link there as well.