Skip to content

DOC: do we want type hints in signature on API pages? #28585

Closed
@jorisvandenbossche

Description

@jorisvandenbossche

With the type hints that are being added in a lot of places, the question comes up if we want to have them in the docs.

Currently, this actually happens. See eg https://dev.pandas.io/docs/reference/api/pandas.DataFrame.to_string.html#pandas.DataFrame.to_string

image

But personally, I am not sure the having the type hints in the signature like above is an improvement. It makes the signature very hard to read and interpret, while we (in principle) already have the type information in textual form in the Parameter listing.

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