Skip to content

DOC: MultiIndex.is_lexsorted not linked #38953

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
kylekeppler opened this issue Jan 4, 2021 · 6 comments
Closed

DOC: MultiIndex.is_lexsorted not linked #38953

kylekeppler opened this issue Jan 4, 2021 · 6 comments
Labels
Milestone

Comments

@kylekeppler
Copy link
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?

@kylekeppler kylekeppler added Docs Needs Triage Issue that has not been reviewed by a pandas team member labels Jan 4, 2021
@jreback
Copy link
Contributor

jreback commented Jan 4, 2021

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

@kylekeppler
Copy link
Contributor Author

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

@jreback
Copy link
Contributor

jreback commented Jan 4, 2021

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

@jreback
Copy link
Contributor

jreback commented Jan 4, 2021

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

@jreback jreback added this to the 1.3 milestone Jan 4, 2021
@kylekeppler
Copy link
Contributor Author

kylekeppler commented Jan 5, 2021 via email

@MarcoGorelli MarcoGorelli removed the Needs Triage Issue that has not been reviewed by a pandas team member label Jan 5, 2021
@kylekeppler
Copy link
Contributor Author

Closed by #38975

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

3 participants