Period index 29204 #29224
Period index 29204 #29224
Conversation
HughKelley
commented
Oct 25, 2019
HughKelley
commented
- closes DOCS: docstrings formatting errors in pandas.PeriodIndex #29204
|
Hello @HughKelley! Thanks for updating this PR. We checked the lines you've touched for PEP 8 issues, and found: There are currently no PEP 8 issues detected in this Pull Request. Cheers! 🍻 Comment last updated at 2019-10-29 14:20:10 UTC |
pandas/core/indexes/period.py
Outdated
|
|
||
| Parameters | ||
| ---------- | ||
| **fields |
There was a problem hiding this comment.
I'm guessing you are documenting this from the __new__ method, but shouldn't be documenting that externally as that isn't something the user would interact with.
Can you see how that actually gets mapped to the individual class constructors? That's what should be documented
There was a problem hiding this comment.
@WillAyd Ok thanks. I documented only because the docstrings validator identified it as missing from the string and raised an error. If the user doesn't define the periodIndex using ordinal or data a range is built using start, end and periods or freq and the other optional arguments held in fields by passing them to periodArray._generate_range(). is that what you mean by how it's mapped?
Should I include that all in the docstring here or somewhere else or does it not matter bc it's not relevant to usage?
