DOC: fixing GL08 errors for pandas.IntervalIndex.left, pandas.IntervalIndex.mid and pandas.IntervalIndex.length

[j36426052]

All GL08 Errors resolved in the following cases:

scripts/validate_docstrings.py --format=actions --errors=GL08 pandas.IntervalIndex.left
scripts/validate_docstrings.py --format=actions --errors=GL08 pandas.IntervalIndex.mid
scripts/validate_docstrings.py --format=actions --errors=GL08 pandas.IntervalIndex.length

xref #57443

[j36426052]

I want to know that what should I do next ? I am not sure what should I fix the error, because some of it I'm not really understand. Or should I just skip it?

[j36426052]

pre-commit.ci autofix

[datapythonista]

I think those are good candidates to reuse a docstring, together with right. You can see how we do it in many places with the @doc decorator.

Some general comments:

• For See Also we want for left to surely have right. I think we actually want to refer the rest of the 4 methods to each other.
• In Return besides the type, in the next line we want to have a description of what's being returned.
• For the Examples we want to assign the interval index to a variable, and then show the method, not to create one instance, and then create it again with the method or property being called.

[mroeschke]

@datapythonista just FYI there's an effort to minimize/remove docstring reuse (#57683, #57578) to minimize complexity of the docstring reuse mechanisms

[datapythonista]

@j36426052 do you want to continue working in this PR? Besides addressing the comments you'll have to resolve the conflicts.

[j36426052]

Sorry that I'm not really sure what part I need to fix. The comment part, should I reuse some comment to let it's structure more complete. I'm not sure how to minimize/remove docstring.

Also the comflict in Numpy Dev, it show "test-data.xml not found", but I don't see some document talk about this.

Or should I just skip the above I mention. Maybe you mean other comflict?

[Aloqeely]

As mroeschke said, there's no need to worry about reusing docstrings as they are trying to minimize docstring reuse.
Focus on applying the 3 suggested "general comments" first.

[mroeschke]

Thanks for the pull request, but it appears to have gone stale. If interested in continuing, please merge in the main branch, address any review comments and/or failing tests, and we can reopen.