Skip to content

DOC: the source link of CategoricalIndex's methods are wrong. #36858

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

Open
8 tasks
junjunjunk opened this issue Oct 4, 2020 · 5 comments
Open
8 tasks

DOC: the source link of CategoricalIndex's methods are wrong. #36858

junjunjunk opened this issue Oct 4, 2020 · 5 comments
Labels
Categorical Categorical Data Type Docs Index Related to the Index class or subclasses

Comments

@junjunjunk
Copy link
Contributor

junjunjunk commented Oct 4, 2020

Location of the documentation

Documentation problem

For example, in pandas.CategoricalIndex.add_categories, the source link jumps to the following source.This link is wrong.
As far as I've observed, the above methods all jump to the same wrong link.

def f(self, *args, **kwargs):
return self._delegate_method(name, *args, **kwargs)

The source link should jump to the following location.

def add_categories(self, new_categories, inplace=False):

Suggested fix for documentation

Correct the source link.

@junjunjunk
Copy link
Contributor Author

take

@dsaxton dsaxton removed the Needs Triage Issue that has not been reviewed by a pandas team member label Oct 4, 2020
@junjunjunk junjunjunk removed their assignment Oct 4, 2020
@aflah02
Copy link
Contributor

aflah02 commented Dec 16, 2020

@junjunjunk is this issue open to do?

@junjunjunk
Copy link
Contributor Author

@aflah02
This issue is open.
No one is assigned, so it's okay to take this issue.

@aflah02
Copy link
Contributor

aflah02 commented Dec 16, 2020

Okk I'll try it then thanks 👍

@aflah02
Copy link
Contributor

aflah02 commented Dec 18, 2020

@junjunjunk I have been trying to look at how redirects are made but couldn't find anything. Like in the browser page there is a source link which upon clicking redirects you however in the documentation at the current linked code there is nothing to indicate that it has been linked

def f(self, *args, **kwargs):
return self._delegate_method(name, *args, **kwargs)

Any idea on how links are actually taken care of in the Documentation?

@mroeschke mroeschke added Categorical Categorical Data Type Index Related to the Index class or subclasses labels Aug 13, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Categorical Categorical Data Type Docs Index Related to the Index class or subclasses
Projects
None yet
Development

No branches or pull requests

4 participants