DOC: CategoricalIndex doc string #24852
@@ Coverage Diff @@ ## master #24852 +/- ## ========================================== - Coverage 92.39% 92.39% -0.01% ========================================== Files 166 166 Lines 52391 52391 ========================================== - Hits 48407 48406 -1 - Misses 3984 3985 +1
@@ Coverage Diff @@ ## master #24852 +/- ## ========================================== + Coverage 91.73% 91.73% +<.01% ========================================== Files 173 173 Lines 52839 52839 ========================================== + Hits 48472 48473 +1 + Misses 4367 4366 -1
Jan 21, 2019
The validation output is
so I think those reported errors are aceptable?
fastpath isn't documented in any other instances where it's used, even where it's not deprecated. For example Series accepts a fastpath parameter, but it's not documented in its doc string.
The output from CategoricalIndex is >80 characters, so the linter complains about line length without the noqa. I don't like adding noqa either, but CategoricalIndex very fast becomes wider that 80 lines, so don't see how to avoid it using noqa, given how the repr of CategoricalIndex is set up currently.
IMO the line breaks for CategoricalIndex should be better enforced, so it's < pd.options.display.width. That could be an idea for a future PR?
@WillAyd since this is maybe not yet perfect, but still a significant improvement compared to status-quo, I would rather just merge it instead of closing, if that is fine with you.
The other docstring examples wrap the output over multiple lines. So that avoids the
I merged master and maded some fixes.