Skip to content

DOC: pandas.Series.str.isspace has wrong documentation #42015

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
felixdivo opened this issue Jun 15, 2021 · 1 comment · Fixed by #42017
Closed

DOC: pandas.Series.str.isspace has wrong documentation #42015

felixdivo opened this issue Jun 15, 2021 · 1 comment · Fixed by #42017

Comments

@felixdivo
Copy link
Contributor

Location of the documentation

pandas.Series.str.isspace

Documentation problem

Check whether all characters in each string are alphanumeric.

This is equivalent to running the Python string method str.isalnum() for each element of the Series/Index. If a string has zero characters, False is returned for that check. Seems like it was somehow copied from pandas.Series.str.isalnum.

That does not seem to match the function.

Suggested fix for documentation

Not copy the doc of pandas.Series.str.isalnum but rather provide a specific one.

@felixdivo felixdivo added Docs Needs Triage Issue that has not been reviewed by a pandas team member labels Jun 15, 2021
@felixdivo felixdivo changed the title DOC: DOC: pandas.Series.str.isspace has wrong documentation Jun 15, 2021
@simonjayhawkins
Copy link
Member

Thanks @felixdivo for the report.

The code is here...

isspace = _map_and_wrap(
"isspace", docstring=_shared_docs["ismethods"] % _doc_args["isalnum"]
)

contributions welcome

@simonjayhawkins simonjayhawkins added good first issue and removed Needs Triage Issue that has not been reviewed by a pandas team member labels Jun 15, 2021
@simonjayhawkins simonjayhawkins added this to the Contributions Welcome milestone Jun 15, 2021
@jreback jreback modified the milestones: Contributions Welcome, 1.3 Jun 15, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants