You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
We currently copy the docstring from the underlying array method, which is at times either vague or incorrect as in the example above. We could instead override the docstring with custom value in pandas/core/accessor.py in the _create_delegator_method function. We would need a place to store the docstrings, and it would be a significant effort to add them all.
Possible approach: Create a new subdirectory, pandas/core/docstrings/ for storing docstrings for purposes like this, and add series_dt.py there. It would contain a dictionary mapping the method name to the docstring.
The text was updated successfully, but these errors were encountered:
Discussed on the last dev call, the plan here is to improve the docstrings on the underlying array methods so that additional and highly redundant documentation does not need to be added. I plan to update the OP with a list of methods and instructions for updating the docstrings. Once that is up, work can commence.
Discussed on the last dev call ... I plan to update the OP with a list of methods and instructions for updating the docstrings. Once that is up, work can commence.
is there anymore discussion needed or can we get the need discussion tag removed. There are no other blockers here?
Ref: #59878 (comment)
E.g. https://pandas.pydata.org/docs/dev/reference/api/pandas.Series.dt.to_period.html
We currently copy the docstring from the underlying array method, which is at times either vague or incorrect as in the example above. We could instead override the docstring with custom value in
pandas/core/accessor.py
in the_create_delegator_method
function. We would need a place to store the docstrings, and it would be a significant effort to add them all.Possible approach: Create a new subdirectory,
pandas/core/docstrings/
for storing docstrings for purposes like this, and addseries_dt.py
there. It would contain a dictionary mapping the method name to the docstring.The text was updated successfully, but these errors were encountered: