Change name of `stats.moment` parameter `moment` to `order`

Matt Haberland <[email protected]> Fri, 29 Dec 2023 20:35:03 -0800
Newsgroups gmane.comp.python.scientific.devel
Message-ID <CADuxUixe_BogHmdn5M+E=2gpE67AuL6zW2QxofiVCOUYx11_6g@mail.gmail.com>
--===============7316920368217915351==
Content-Type: multipart/alternative; boundary="000000000000ebeb3b060db2ac53"

--000000000000ebeb3b060db2ac53
Content-Type: text/plain; charset="UTF-8"

Hi team,

`scipy.stats.moment` has a parameter named `moment`. Given that the
description is

> Order of central moment that is returned

and the name of the equivalent argument of `scipy.stats.rv_generic.moment`
is `order`, the name `order` would be more appropriate for the parameter.

gh-19689 would change the name of the parameter to `order`, but still allow
use of keyword `moment` to avoid disruption to existing users.

Please let us know your thoughts here or in the PR:
https://github.com/scipy/scipy/pull/19689

Matt

--000000000000ebeb3b060db2ac53
Content-Type: text/html; charset="UTF-8"
Content-Transfer-Encoding: quoted-printable

<div dir=3D"auto"><div dir=3D"ltr"><p style=3D"box-sizing:border-box;margin=
-top:0px;margin-bottom:16px;color:rgb(31,35,40);font-family:-apple-system,&=
quot;system-ui&quot;,&quot;Segoe UI&quot;,&quot;Noto Sans&quot;,Helvetica,A=
rial,sans-serif,&quot;Apple Color Emoji&quot;,&quot;Segoe UI Emoji&quot;;fo=
nt-size:14px">Hi team,</p><p dir=3D"auto" style=3D"box-sizing:border-box;ma=
rgin-top:0px;margin-bottom:16px;color:rgb(31,35,40);font-family:-apple-syst=
em,&quot;system-ui&quot;,&quot;Segoe UI&quot;,&quot;Noto Sans&quot;,Helveti=
ca,Arial,sans-serif,&quot;Apple Color Emoji&quot;,&quot;Segoe UI Emoji&quot=
;;font-size:14px">`scipy.stats.moment` has a parameter named `moment`. Give=
n that the description is</p><p dir=3D"auto" style=3D"box-sizing:border-box=
;margin-top:0px;margin-bottom:16px;color:rgb(31,35,40);font-family:-apple-s=
ystem,&quot;system-ui&quot;,&quot;Segoe UI&quot;,&quot;Noto Sans&quot;,Helv=
etica,Arial,sans-serif,&quot;Apple Color Emoji&quot;,&quot;Segoe UI Emoji&q=
uot;;font-size:14px">&gt; Order of central moment that is returned</p><p st=
yle=3D"box-sizing:border-box;margin-top:0px;margin-bottom:16px;color:rgb(31=
,35,40);font-family:-apple-system,&quot;system-ui&quot;,&quot;Segoe UI&quot=
;,&quot;Noto Sans&quot;,Helvetica,Arial,sans-serif,&quot;Apple Color Emoji&=
quot;,&quot;Segoe UI Emoji&quot;;font-size:14px">and the name of the equiva=
lent argument of `scipy.stats.rv_generic.moment` is `order`, the name `orde=
r` would be more appropriate for the parameter.<br></p><p style=3D"box-sizi=
ng:border-box;margin-top:0px;margin-bottom:16px;color:rgb(31,35,40);font-fa=
mily:-apple-system,&quot;system-ui&quot;,&quot;Segoe UI&quot;,&quot;Noto Sa=
ns&quot;,Helvetica,Arial,sans-serif,&quot;Apple Color Emoji&quot;,&quot;Seg=
oe UI Emoji&quot;;font-size:14px">gh-19689 would change the name of the par=
ameter to `order`, but still allow use of keyword `moment` to avoid disrupt=
ion to existing users.</p><p style=3D"box-sizing:border-box;margin-top:0px;=
margin-bottom:16px;color:rgb(31,35,40);font-family:-apple-system,&quot;syst=
em-ui&quot;,&quot;Segoe UI&quot;,&quot;Noto Sans&quot;,Helvetica,Arial,sans=
-serif,&quot;Apple Color Emoji&quot;,&quot;Segoe UI Emoji&quot;;font-size:1=
4px">Please let us know your thoughts here or in the PR:<br><a href=3D"http=
s://github.com/scipy/scipy/pull/19689" rel=3D"noreferrer noreferrer" target=
=3D"_blank">https://github.com/scipy/scipy/pull/19689</a></p><p style=3D"bo=
x-sizing:border-box;margin-top:0px;margin-bottom:16px;color:rgb(31,35,40);f=
ont-family:-apple-system,&quot;system-ui&quot;,&quot;Segoe UI&quot;,&quot;N=
oto Sans&quot;,Helvetica,Arial,sans-serif,&quot;Apple Color Emoji&quot;,&qu=
ot;Segoe UI Emoji&quot;;font-size:14px">Matt</p></div></div>

--000000000000ebeb3b060db2ac53--

--===============7316920368217915351==
Content-Type: text/plain; charset="us-ascii"
MIME-Version: 1.0
Content-Transfer-Encoding: 7bit
Content-Disposition: inline

_______________________________________________
SciPy-Dev mailing list -- [email protected]
To unsubscribe send an email to [email protected]
https://mail.python.org/mailman3/lists/scipy-dev.python.org/
Member address: [email protected]

--===============7316920368217915351==--