Skip to content

Clearly document what a list-like is #21784

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

Open
toobaz opened this issue Jul 7, 2018 · 1 comment
Open

Clearly document what a list-like is #21784

toobaz opened this issue Jul 7, 2018 · 1 comment
Labels
API - Consistency Internal Consistency of API/Behavior Docs

Comments

@toobaz
Copy link
Member

toobaz commented Jul 7, 2018

I think we need a doc section which states what is accepted as list-like: each method which accepts list-likes would then link to that doc section.

This will basically detail the types for which pandas.core.dtypes.common.is_list_like returns True, with the only exception of tuple, which we should not declare as list-like, but which some methods still accept for backward compatibility.

@datapythonista
Copy link
Member

+1

I thought on this too. Not sure if there are more things that would benefit from a definition to have a glossary page in the doc.

@jbrockmendel jbrockmendel added the API - Consistency Internal Consistency of API/Behavior label Sep 21, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
API - Consistency Internal Consistency of API/Behavior Docs
Projects
None yet
Development

No branches or pull requests

3 participants