[WIP]Improve permutation_test_score docstring #10931
Conversation
| @@ -787,6 +787,8 @@ Changelog | |||
|
|
|||
| - :ref:`olivetti_faces` by `David Warde-Farley`_. | |||
|
|
|||
| - :func:`model_selection.model_selection.permutation_test_score` by `Alexandre Gramfort`_. | |||
|
|
|||
There was a problem hiding this comment.
@amueller
How can I deal with modifying the changelog retrospectively? 🤔
The original function has been added to scikits.learn.cross_val.py module. How do I need to refer to it now?
There was a problem hiding this comment.
Adding it to an old whatsnew is not usually something we do. You can do a "versionadded" if you want (thought it would be the earliest whatsnew in the code base for sure). We don't really guarantee completeness of the changelog.
| @@ -877,7 +879,7 @@ People | |||
| - 127 `Jake Vanderplas`_ | |||
| - 120 `Mathieu Blondel`_ | |||
| - 85 `Alexandre Passos`_ | |||
| - 67 `Alexandre Gramfort`_ | |||
| - 68 `Alexandre Gramfort`_ | |||
There was a problem hiding this comment.
that's not what that counts ;) I suggest just leaving this file alone, I was just complaining.
There was a problem hiding this comment.
Can you undo this and the changelog fix please?
|
The main complaint was that there is no mention in the user guide, i.e. here: The link in the docstring here should link to a portion to the user guide explaining what the function is for: |
|
Oh my bad 🤕 |
|
Closing since the original issue was fixed in #17373 |
Reference Issues/PRs
Fixes #10905
What does this implement/fix? Explain your changes.
Improves the docstring of
permutation_test_scoreand modifies change log section inwhats_newmodule