Skip to content

[MRG] DOC kwonly section in whatsnew #17059

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Apr 27, 2020
Merged

[MRG] DOC kwonly section in whatsnew #17059

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
cda36fa
added section abobut kwonly
NicolasHug Apr 27, 2020
6fedff8
title
NicolasHug Apr 27, 2020
a15cc7c
minor update
NicolasHug Apr 27, 2020
c9ed3af
actually a TypeError
NicolasHug Apr 27, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 14 additions & 6 deletions doc/whats_new/v0.23.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,20 @@ Version 0.23.0

Put the changes in their relevant module.

Enforcing keyword-only arguments
--------------------------------

In an effort to promote clear and non-ambiguous use of the library, most
constructor and function parameters are now expected to be passed as keyword
arguments (i.e. using the `param=value` syntax) instead of positional. To
ease the transition, a `FutureWarning` is raised if a keyword-only parameter
is used as positional. In version 0.25, these parameters will be strictly
keyword-only, and a `TypeError` will be raised.
:issue:`15005` by `Joel Nothman`_, `Adrin Jalali`_, `Thomas Fan`_, and
`Nicolas Hug`_. See `SLEP009
<https://scikit-learn-enhancement-proposals.readthedocs.io/en/latest/slep009/proposal.html>`_
for more details.

Changed models
--------------

Expand Down Expand Up @@ -536,12 +550,6 @@ Miscellaneous
error message is raised when y was expected but None was passed.
:pr:`16622` by `Nicolas Hug`_.

- |API| Most constructor and function parameters are now expected to be passed
as a keyword and not positional. :issue:`15005` by `Joel Nothman`_,
`Adrin Jalali`_, `Thomas Fan`_, and `Nicolas Hug`_. See `SLEP009
<https://scikit-learn-enhancement-proposals.readthedocs.io/en/latest/slep009/proposal.html>`_
for more details.

Code and Documentation Contributors
-----------------------------------

Expand Down