DOC: Show constructor arguments for some classes in pd.series.offsets
#61605
Conversation
| f"\'{c_PERIOD_AND_OFFSET_DEPR_FREQSTR.get(name)}\'" | ||
| f" instead.", | ||
| f"\'{c_PERIOD_AND_OFFSET_DEPR_FREQSTR.get(name)}\' " | ||
| f"instead.", |
There was a problem hiding this comment.
@Dr-Irv this and the following change have for some time caused pre-commit to fail for me locally.
great that this is being fixed here. Thanks.
Any idea why CI hasn't picked this up before now?
There was a problem hiding this comment.
No, I was surprised as well.
|
/preview |
|
No strong opinions about this, but if the examples need the okexcept on windows sounds like this change is breaking things on windows, no? I guess I'm missing something, if you can clarify. But it would be better to fix the underlying problem, I don't think we should add okexcept unless we document exceptions. |
No, the change is needed to just build the regular documentation (without this change) on Windows. It has something to do with how sphinx calls cython and that doesn't seem to work right on Windows. Not sure exactly what the problem is. |
I found a better fix in #61686 . So the |
|
/preview |
1 similar comment
|
/preview |
|
Website preview of this PR available at: https://pandas.pydata.org/preview/pandas-dev/pandas/61605/ |
This contributes to #52431
In that issue, the goal is to show the arguments for the constructors for the various offsets, which are all in
pyxfiles.The problem is that
sphinxdoesn't pick up the arguments for__init__()in those files. It seems that if you haveclassthat is a not acdef class, you have to have a__new__()method so the docs show up. This PR does this forYearEnd, by creating acdef _YearEndclass. and thenYearEndis a regular class with__new__()calling__new__()of_YearEnd. So, if you preview the docs from this MR, you will see thatYearEndnow shows its constructor.If this PR is accepted, then we can get the community to do the work of separating the classes into "public" and "private" ones and adding adding the
__new__()methods to the other documented offset classes and they can also add aParameterssection to those classes. Note that forYearEnd, I had to change the docs fromAttributestoParametersto make it so that the docstrings are validated.