[MRG + 1] DOC :issue: role to simplify what's news#7657
[MRG + 1] DOC :issue: role to simplify what's news#7657jnothman merged 5 commits intoscikit-learn:masterfrom
Conversation
|
To emphasise the benefit of |
|
The dependency police will never let this go through :)
|
|
The code's in the repo. All 105 lines of it. |
|
I mean, we could rewrite those macros, but why? |
Fair enough. I have an alergy to sphinx extensions / macros because:
|
|
:) But these:
|
|
Honestly, no one checks what's new rendering in review, so we should at least make it easy syntactically to add entries! |
|
As a concession to your very valid remarks, @GaelVaroquaux, I have crossed out the possibility of using the |
|
|
|
|
||
| - Fix issue where ``min_grad_norm`` and ``n_iter_without_progress`` | ||
| parameters were not being utilised by :class:`manifold.TSNE`. | ||
| `#6497 <https://github.com/scikit-learn/scikit-learn/pull/6497>`_ |
There was a problem hiding this comment.
niptick: you could remove the line break here and there
There was a problem hiding this comment.
I realise. I've not worked out the regex to do so, and have little time to put to it manually. Contrib welcome.
|
The readability is indeed much better, yet I have no opinion upon adding rst macro. |
|
yes please, I just fixed many of them manually. |
|
I would also be +1 on the user role because a) the list at the bottom will get pretty long and b) people don't know how the references work and add a link to a name that is not declared at the bottom. |
Shh, Andy, one change at a time and we'll get this through the censors :P |
|
Anyone have an easy way to fix up the line wrapping, or do I need to think? |
|
Shh, Andy, one change at a time and we'll get this through the censors :P
:P
If people are convinced that it's a good idea, I certainly won't veto it.
I am much more worried by the core codebase getting too complex than by
this.
Thanks for your efforts!
|
Yes, I appreciate this. Some of the complexity is part of maturation. Some of it is having accepted too much breadth that we're beginning to struggle to maintain. |
86b5ea4 to
ae7b9f2
Compare
|
I've neatened up wrapping etc. Merge or rejection welcome before rebase gets out of hand. |
|
+1 |
|
I had two PRs within the last two days that had missing links for users... |
|
@ogrisel @agramfort @raghavrv wdyt? |
|
But the extension doesn't currently support user links with custom anchor On 21 October 2016 at 01:13, Andreas Mueller notifications@github.com
|
|
I am +1 for this because
|
|
@jnothman right. I'll send a patch upstream? |
|
I'm happy to merge this as-is though |
|
Let's do the merge and maybe make an issue for that later? |
|
@raghavrv @jnothman made an issue here: sloria/sphinx-issues#1 and I made a PR here: sloria/sphinx-issues#3 |
|
I am 👍 for the merge now. This makes the what's new page much more readable. |
|
Merging. @amueller, I think it would be a good idea to backport changes into 0.18.X |
|
yeah, but I feel like we should update the version with the one that is currently in upstream. This one doesn't include my patch for the user names, right? |
|
But you made no changes to the feature used here. I've made an issue for #7748 |
I find the issue links in what's new to take up far too much space. The sphinx-issues project provides RST roles to simplify this, which I have here imported. I've just translated a sample to the role format, and will do more by regular expression shortly if others think this is a good idea.
It would also be good to use something like:for irregular contributors so we don't often need to modify the list of hyperlink targets at the bottom of the file. However, sphinx-issues does not currently support custom anchor text