Skip to content

DOC: Imprecision in the type description of pd.concat parameter #56845

@kodimatrix

Description

@kodimatrix

Pandas version checks

  • I have checked that the issue still exists on the latest versions of the docs on main here

Location of the documentation

https://pandas.pydata.org/docs/reference/api/pandas.concat.html

Documentation problem

The pd.concat() function has a parameter obj with the typing hint:: Iterable (and other). It is possible to call this function with a generator, for example. However, the documentation refers to it as "a sequence...". According to the glossary (and collections.abs module, respectively), this is a small imprecision.

https://docs.python.org/3/glossary.html#term-iterable
https://docs.python.org/3/glossary.html#term-sequence

Suggested fix for documentation

Replace "sequence" with "iterable".

Metadata

Metadata

Assignees

Labels

DocsReshapingConcat, Merge/Join, Stack/Unstack, Explode

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions