Skip to content

Fix formatting of engine parameter in docstrings #2846

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 2 commits into from
Mar 25, 2019
Merged

Fix formatting of engine parameter in docstrings #2846

merged 2 commits into from
Mar 25, 2019

Conversation

spencermathews
Copy link
Contributor

The formatting of the engine parameter is wonky in the docs of open_dataset(), open_mfdataset(), open_dataarray().

To maintain consistent format with the other parameters once the docs are build, text up through the word optional should be on the same line as the parameter name. Currently it's pushed down into the parameter description.

@pep8speaks
Copy link

pep8speaks commented Mar 22, 2019

Hello @spencermathews! 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-03-22 21:31:25 UTC

@shoyer
Copy link
Member

shoyer commented Mar 22, 2019

Hmm. I wish there was a way to do this so both sphinx and lint checkers were happy.

@spencermathews
Copy link
Contributor Author

spencermathews commented Mar 22, 2019

Yes, it seemed like such a simple fix, until the PEP 8 bit. I came across numpy/numpydoc#87, which seems apropos. I pushed an update that should fix the linter error. If sphinx isn't happy it's not complaining.

@shoyer shoyer merged commit 72e6208 into pydata:master Mar 25, 2019
@shoyer
Copy link
Member

shoyer commented Mar 25, 2019

thanks for looking into this @spencermathews !

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants