-
-
Notifications
You must be signed in to change notification settings - Fork 18.5k
DOC: Change "Convention for examples" to use Series name as ser
instead of s
#53271
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.
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
Comments
thanks - yeah I've seen people request non-single-letter-variables in reviews, but the docstring guide still advises to use them - looks like the preference changed but nobody codified it. Would be good to change it |
+1 |
Hello! I'd be happy to work on this issue. |
Hi @austinburnett ! Great, please go ahead. |
Hey @DeaMariaLeon @MarcoGorelli I believed I finished up the issue! #53312 |
First time contribution to open source. Please guide me as to what is the first step I can take |
@austinburnett we commented there, thanks. @shreevaths1 : This issue is taken. But you can take a look at https://pandas.pydata.org/docs/development/contributing.html#where-to-start |
Pandas version checks
main
hereLocation of the documentation
https://pandas.pydata.org/docs/dev/development/contributing_docstring.html#conventions-for-the-examples
Documentation problem
There's a general preference to use
ser =
instead ofs =
in examplesPer @MarcoGorelli
Suggested fix for documentation
Change
s
toser
on paragraph:"When illustrating examples with a single Series use the name
s
, and if illustrating with a single DataFrame use the name df. For indices, idx is the preferred name. If a set of homogeneous Series or DataFrame is used, name thems1
,s2
,s3
"The text was updated successfully, but these errors were encountered: