Skip to content

DOC: MultiIndex.is_lexsorted not linked #38953

@kylekeppler

Description

@kylekeppler
Contributor

Location of the documentation

https://pandas.pydata.org/docs/dev/reference/api/pandas.MultiIndex.html?highlight=is_lexsorted

Documentation problem

On the API page for MultiIndex, is_lexsorted does not link to an API page for that method. That method has been deprecated and does not contain a docstring, perhaps that is why there is no link?

Suggested fix for documentation

Since this method is deprecated, suggest removing is_lexsorted from the list of methods on the MultiIndex API page. Alternatively could add a docstring and API page.

What is preferred?

Activity

jreback

jreback commented on Jan 4, 2021

@jreback
Contributor

we just merged a PR which deprecated is_lexsorted, which removed it from the api docs. #38701

kylekeppler

kylekeppler commented on Jan 4, 2021

@kylekeppler
ContributorAuthor

Good timing then! Looks like the is_lexsorted entry in the MultiIndex docstring should be removed?

jreback

jreback commented on Jan 4, 2021

@jreback
Contributor

it is in the PR
you have to look at the dev docs build

jreback

jreback commented on Jan 4, 2021

@jreback
Contributor

ahh I know we need to remove that reference (that you pointed above). if you would do a PR would be great!

added this to the 1.3 milestone on Jan 4, 2021
kylekeppler

kylekeppler commented on Jan 5, 2021

@kylekeppler
ContributorAuthor
removed
Needs TriageIssue that has not been reviewed by a pandas team member
on Jan 5, 2021
kylekeppler

kylekeppler commented on Jan 6, 2021

@kylekeppler
ContributorAuthor

Closed by #38975

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

    Relationships

    None yet

      Development

      No branches or pull requests

        Participants

        @jreback@kylekeppler@MarcoGorelli

        Issue actions

          DOC: MultiIndex.is_lexsorted not linked · Issue #38953 · pandas-dev/pandas