Skip to content

DOC: include Offset.__call__ to autosummary to fix sphinx warning #33309

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 1 commit into from
Apr 6, 2020

Conversation

jbrockmendel
Copy link
Member

No description provided.

@jbrockmendel
Copy link
Member Author

@datapythonista is this the right way to fix the doc build?

@datapythonista
Copy link
Member

I'm not sure, sphinx still confuses me with those. @jorisvandenbossche knows better.

@jorisvandenbossche
Copy link
Member

It clearly fixes it, because CI is green ;)

Now, the actual answer: it depends. Are we fine with including the __call__ docstring? Is this considered public / documented in the user guide?

@jreback
Copy link
Contributor

jreback commented Apr 6, 2020

It clearly fixes it, because CI is green ;)

Now, the actual answer: it depends. Are we fine with including the __call__ docstring? Is this considered public / documented in the user guide?

these are public methods.

@jorisvandenbossche
Copy link
Member

Then the fix is fine

@jorisvandenbossche jorisvandenbossche changed the title CI: troubleshoot docbuild DOC: include Offset.__call__ to autosummary to fix sphinx warning Apr 6, 2020
@jorisvandenbossche jorisvandenbossche merged commit a9c105a into pandas-dev:master Apr 6, 2020
@jorisvandenbossche
Copy link
Member

Thanks @jbrockmendel !

@simonjayhawkins
Copy link
Member

@meeseeksdev backport to 1.0.x

meeseeksmachine pushed a commit to meeseeksmachine/pandas that referenced this pull request May 4, 2020
simonjayhawkins pushed a commit that referenced this pull request May 4, 2020
@simonjayhawkins simonjayhawkins modified the milestones: 1.1, 1.0.4 May 26, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CI Continuous Integration Docs
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants