Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Appearance settings

DOC: defaults in method signature vs description #59880

Copy link
Copy link
Open
@kuraga

Description

@kuraga
Issue body actions

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

Everywhere.

Documentation problem

The default value in method signature and the default value in the method description is sometimes different.
Examples:

https://pandas.pydata.org/docs/reference/api/pandas.Series.replace.html:
does Series.replace's:
to_replace have None (docs signature) as default, or have no default (docs description)?
value have no default (docs signature), or None (docs description)?

https://pandas.pydata.org/docs/reference/api/pandas.read_csv.html:
does read_csv's:
sep have no default (docs signature), or ';' (docs description)?
...

...

Suggested fix for documentation

Fix.

Metadata

Metadata

Assignees

No one assigned

    Labels

    DocsNeeds DiscussionRequires discussion from core team before further actionRequires discussion from core team before further action

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions

      Morty Proxy This is a proxified and sanitized view of the page, visit original site.