Skip to content

DOC: Improve the register_index_accessor Documentation #49202

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.

Sign up for GitHub

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

Jump to bottom
Closed
1 task done
achapkowski opened this issue Oct 20, 2022 · 10 comments · Fixed by #57867
Closed
1 task done

DOC: Improve the register_index_accessor Documentation #49202

achapkowski opened this issue Oct 20, 2022 · 10 comments · Fixed by #57867
Assignees
@SolOlga @vishallb @sjalkote @ShreyashThengne
Labels
Accessors accessor registration mechanism (not .str, .dt, .cat) Docs good first issue

Comments

@achapkowski
Copy link

Pandas version checks

  • I have checked that the issue still exists on the latest versions of the docs on main here

Location of the documentation

https://pandas.pydata.org/docs/reference/api/pandas.api.extensions.register_index_accessor.html#pandas.api.extensions.register_index_accessor

Documentation problem

There is no example showing how to create or what is required on the class to make an index accessor.

Suggested fix for documentation

Add a link to an example or expand the topic to include a how to implement this. Also document what is required to make a custom indexer.
@achapkowski achapkowski added Docs Needs Triage Issue that has not been reviewed by a pandas team member labels Oct 20, 2022
@achapkowski achapkowski changed the title DOC: DOC: Improve the register_index_accessor Documentation Oct 20, 2022
@phofl phofl added good first issue and removed Needs Triage Issue that has not been reviewed by a pandas team member labels Oct 20, 2022
@kanpuriyanawab kanpuriyanawab mentioned this issue Oct 21, 2022
Closed
4 tasks
@AnkitKashyap0709
Copy link

Hey, I've started recently on open-source contributions. And I want to help in contributing to the library pandas. I see already that no one is assigned here. I would like to get started on this.

@achapkowski
Copy link
Author

@AnkitKashyap0709 go for it

@mohit-marathe
Copy link

Hey, I'm new to open-source contributions and I want this to be my one of the first contributions. Can I work on this?

@vishallb
Copy link

vishallb commented Nov 8, 2022

take

@pranav-ravuri
Copy link
Contributor

pranav-ravuri commented Mar 27, 2023 •
edited
Loading

Hi @vishallb what's the status on this issue? Can I take this issue, I am interested

@ShreyashThengne
Copy link

take

@jbrockmendel jbrockmendel added the Accessors accessor registration mechanism (not .str, .dt, .cat) label Jul 27, 2023
@SolOlga
Copy link

SolOlga commented Oct 1, 2023

take

@SolOlga
Copy link

SolOlga commented Oct 1, 2023

Hi, I saw that no one touched this issue for three months so I'll try to take it.

@SolOlga SolOlga mentioned this issue Oct 8, 2023
Closed
2 tasks
@sjalkote
Copy link
Contributor

sjalkote commented Mar 6, 2024

Hi, looks like this has been inactive for a few months so I'd like to try it

@sjalkote
Copy link
Contributor

sjalkote commented Mar 6, 2024

take

@sjalkote sjalkote mentioned this issue Mar 16, 2024
Merged
2 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@SolOlga SolOlga

@vishallb vishallb

@sjalkote sjalkote

@ShreyashThengne ShreyashThengne

Labels
Accessors accessor registration mechanism (not .str, .dt, .cat) Docs good first issue
Projects
None yet
Milestone
No milestone
10 participants
@achapkowski @jbrockmendel @SolOlga @phofl @AnkitKashyap0709 @vishallb @pranav-ravuri @sjalkote @mohit-marathe @ShreyashThengne