pandas-dev / pandas

Flexible and powerful data analysis / manipulation library for Python, providing labeled data structures similar to R data.frame objects, statistical functions, and much more
https://pandas.pydata.org
BSD 3-Clause "New" or "Revised" License
43.43k stars 17.85k forks source link

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

Open Sherry3 opened 2 years ago

Sherry3 commented 2 years ago

Pandas version checks

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 commented 2 years ago

take

phofl commented 2 years ago

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

ns-sdalodia commented 2 years ago

Master issue already exists - https://github.com/pandas-dev/pandas/issues/27977. This issue is kind of subgroup only.

tqa236 commented 7 months ago

In my opinion, this issue can be closed in favor of https://github.com/pandas-dev/pandas/issues/57443, which has a better instruction for the workflow to fix these errors