Skip to content

DOC: reduce API docs for offset aliases #34433

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Jun 19, 2020

Conversation

jorisvandenbossche
Copy link
Member

Test to see if this works with sphinx

@jbrockmendel
Copy link
Member

Nice, there are some other aliases we could do the same for if this works.

Also some methods/properties that dont need to be advertised, e.g. __call__

@jorisvandenbossche
Copy link
Member Author

Yeah, first need to see if it works ;)
(locally it did, but I would actually expect to need to edit the BDay docstring to ensure it lists no methods/attributes, similar as eg the docstring of DatetimeArray)

@jorisvandenbossche
Copy link
Member Author

It seems to work.

Can you say which are the aliases? Just the ones here?

BDay = BusinessDay
BMonthEnd = BusinessMonthEnd
BMonthBegin = BusinessMonthBegin
CBMonthEnd = CustomBusinessMonthEnd
CBMonthBegin = CustomBusinessMonthBegin
CDay = CustomBusinessDay

@jreback jreback added the Frequency DateOffsets label May 28, 2020
@jbrockmendel
Copy link
Member

I think thats all of them, yes.

@jorisvandenbossche jorisvandenbossche merged commit c823642 into pandas-dev:master Jun 19, 2020
@jorisvandenbossche jorisvandenbossche deleted the doc-bday branch June 19, 2020 11:01
@jorisvandenbossche jorisvandenbossche added this to the 1.1 milestone Jun 19, 2020
wesbarnett pushed a commit to wesbarnett/pandas that referenced this pull request Jun 20, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants