Skip to content

Is it necessary to unify pandas and pd in docstring? #20604

Closed
@icyblade

Description

@icyblade

There are two kinds of demonstration of pandas in current docstring, pandas. and pd..

For example, pd.:

msg = ('cannot concatenate object of type "{0}";'
       ' only pd.Series, pd.DataFrame, and pd.Panel'
       ' (deprecated) objs are valid'.format(type(obj)))

and pandas.:

warnings.warn("The pandas.json module is deprecated and will be "
              "removed in a future version. Please import from "
              "pandas.io.json instead", FutureWarning, stacklevel=2)

pd. is friendly to experienced pandas users, but it may lead to misunderstanding for newbies(no offence).
So is it necessary to unify these two presentations?

I'd like to create a PR if it's necessary.

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions