Skip to content

DOC: Update documentation for pd.Interval if string endpoints are not allowed anymore #36002

Closed
@souris-dev

Description

@souris-dev

Location of the documentation

https://pandas.pydata.org/pandas-docs/stable/reference/api/pandas.Interval.html

On master:
https://pandas.pydata.org/docs/dev/reference/api/pandas.Interval.html

Documentation problem

The examples in the documentation for pd.Interval show in the end that Intervals with string endpoints can also be created. However, when the example is run on master, a ValueError is raised, saying:

"Only numeric, Timestamp and Timedelta endpoints are allowed when constructing an Interval."

Suggested fix for documentation

If Intervals with strings as endpoints are not allowed anymore, this example should be removed from the documentation.

I've confirmed that the docstring still contains this example, so I'd be happy to make a PR for this if we agree.

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

    Milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions