Skip to content
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

DOC: GL08 errors in pandas.Index, pandas.IntervalIndex and pandas.MultiIndex #48832

Open
1 task done
Sherry3 opened this issue Sep 28, 2022 · 4 comments
Open
1 task done

DOC: GL08 errors in pandas.Index, pandas.IntervalIndex and pandas.MultiIndex #48832

Sherry3 opened this issue Sep 28, 2022 · 4 comments
Assignees
@Sherry3
Labels
Docs Index Related to the Index class or subclasses

Comments

@Sherry3
Copy link

Sherry3 commented Sep 28, 2022

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/dev/reference/api/pandas.Index.names.html
https://pandas.pydata.org/docs/dev/reference/api/pandas.Index.view.html
https://pandas.pydata.org/docs/dev/reference/api/pandas.IntervalIndex.left.html
https://pandas.pydata.org/docs/dev/reference/api/pandas.IntervalIndex.right.html
https://pandas.pydata.org/docs/dev/reference/api/pandas.IntervalIndex.mid.html
https://pandas.pydata.org/docs/dev/reference/api/pandas.IntervalIndex.length.html
https://pandas.pydata.org/docs/dev/reference/api/pandas.MultiIndex.levels.html
https://pandas.pydata.org/docs/dev/reference/api/pandas.MultiIndex.codes.html

Documentation problem

GL08 errors: The object does not have a docstring.

  1. None:None:GL08:pandas.Index.names:The object does not have a docstring
  2. None:None:GL08:pandas.Index.view:The object does not have a docstring
  3. None:None:GL08:pandas.IntervalIndex.left:The object does not have a docstring
  4. None:None:GL08:pandas.IntervalIndex.right:The object does not have a docstring
  5. None:None:GL08:pandas.IntervalIndex.mid:The object does not have a docstring
  6. None:None:GL08:pandas.IntervalIndex.length:The object does not have a docstring
  7. None:None:GL08:pandas.MultiIndex.levels:The object does not have a docstring
  8. None:None:GL08:pandas.MultiIndex.codes:The object does not have a docstring

Suggested fix for documentation

Add docstrings.
@Sherry3 Sherry3 added Docs Needs Triage Issue that has not been reviewed by a pandas team member labels Sep 28, 2022
@Sherry3
Copy link
Author

Sherry3 commented Sep 28, 2022

take

@rhshadrach rhshadrach added Index Related to the Index class or subclasses and removed Needs Triage Issue that has not been reviewed by a pandas team member labels Sep 28, 2022
@rhshadrach rhshadrach added this to the Contributions Welcome milestone Sep 28, 2022
@phofl
Copy link
Member

phofl commented Sep 29, 2022

Can we maybe combine all these issues into a single one with subgroups?

@ns-sdalodia
Copy link

Master issue already exists - #27977.
This issue is kind of subgroup only.

@Sherry3 Sherry3 mentioned this issue Oct 6, 2022
Closed
5 tasks
@mroeschke mroeschke removed this from the Contributions Welcome milestone Oct 13, 2022
@tqa236
Copy link
Contributor

tqa236 commented Mar 10, 2024

In my opinion, this issue can be closed in favor of #57443, which has a better instruction for the workflow to fix these errors

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

@Sherry3 Sherry3

Labels
Docs Index Related to the Index class or subclasses
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

#48832: GL08 - Added missing docstrings Sherry3/pandas
6 participants
@mroeschke @tqa236 @Sherry3 @rhshadrach @phofl @ns-sdalodia