Skip to content
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

Set docstring linewidth to 75 to avoid wrapping in jupyterlab help popup #1939

Merged
merged 2 commits into from
Dec 3, 2019

Conversation

joelostblom
Copy link
Contributor

I noticed that I didn't cover the one line chart descriptions in #1866, so adding them in this PR.

Current:
image

Suggested:
image

When I did this I noticed that the exact line width that jupyterlab breaks at is 76, not 78, so I updated the autoformatting of the docs as well.

@joelostblom
Copy link
Contributor Author

joelostblom commented Dec 3, 2019

I should note that the pep8 recommendation for doscstrings is a line width of 72 so I can change to that if desired. I looked around briefly in the rest of the plotly code and it seems like a both 72 and 75 is used, so either should be fine for consistency within the project. I am happy with either, I just want the docstrings to fit without wrapping in the help dialog boxes.

@nicolaskruchten
Copy link
Contributor

Thanks for this! Let's stick with 75 for now unless we can easily force everything to 72 :)

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.

2 participants