Skip to content

DOC: inconsistency in doc argument types #40560

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

Closed
jreback opened this issue Mar 21, 2021 · 4 comments · Fixed by #41295
Closed

DOC: inconsistency in doc argument types #40560

jreback opened this issue Mar 21, 2021 · 4 comments · Fixed by #41295
Labels
Code Style Code style, linting, code_checks Docs good first issue
Milestone

Comments

@jreback
Copy link
Contributor

jreback commented Mar 21, 2021

This is not exactly right, but we have an inconsitency in the argument specifications of using 'array_like' vs 'array-like', in argument types we should settle on one (prob 'array-like')

(pandas-dev) ~/pandas$ grep -r array-like --include '*.py' pandas|wc
     317    2259   24072
(pandas-dev) ~/pandas$ grep -r array_like --include '*.py' pandas|wc
     104     498    7414

Similar to this

pandas/plotting/_core.py:    yerr : DataFrame, Series, array-like, dict and str
@jreback jreback added Docs Code Style Code style, linting, code_checks labels Mar 21, 2021
@jreback jreback added this to the Contributions Welcome milestone Mar 21, 2021
@jreback
Copy link
Contributor Author

jreback commented Mar 21, 2021

cc @MarcoGorelli @WillAyd not sure if this is the doc-string validation and/or precommit checks.

@WillAyd
Copy link
Member

WillAyd commented Mar 22, 2021

Not aware of any validation currently - I'd agree that array-like is better

@MarcoGorelli
Copy link
Member

agreed on array-like - will look into this

@kemcbride
Copy link
Contributor

Hi, I'm a noob hunting for easy first issue and this seems like a prime target. Hopefully I can knock this one out pretty quick. PR coming soon!

@simonjayhawkins simonjayhawkins modified the milestones: Contributions Welcome, 1.3 Jun 12, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Code Style Code style, linting, code_checks Docs good first issue
Projects
None yet
Development

Successfully merging a pull request may close this issue.

6 participants