Docstring touchups #1866
Docstring touchups #1866
Conversation
This already shows up in the error message when passing "points" an illegal argument
The docstring already mentions that the points parameter can be used to control the whisker length, but it does not document how which lead to plotly#522
| @@ -444,7 +446,7 @@ | |||
|
|
|||
|
|
|||
| def make_docstring(fn): | |||
| tw = TextWrapper(width=79, initial_indent=" ", subsequent_indent=" ") | |||
| tw = TextWrapper(width=77, initial_indent=" ", subsequent_indent=" ") | |||
There was a problem hiding this comment.
not sure I understand this change...
There was a problem hiding this comment.
It's to prevent spillover in the help message that pops up when clicking shift + tab in Jupyter notebooks. I thought the width for that was 79 when I reformatted the docstrings previously, but noticed today that it actually is 77.
Before:
After:
There was a problem hiding this comment.
OK thank you for the explanation! It's weird however because I don't have the problem
There was a problem hiding this comment.
Which version of jupyter are you using? Mine is
$ jupyter --version
jupyter core : 4.5.0
jupyter-notebook : 6.0.1
qtconsole : 4.5.5
ipython : 7.8.0
ipykernel : 5.1.2
jupyter client : 5.3.1
jupyter lab : 1.1.4
nbconvert : 5.6.0
ipywidgets : 7.5.1
nbformat : 4.4.0
traitlets : 4.3.2
There was a problem hiding this comment.
But I'm using a dark theme for jupyter which might tune the configuration. I also tested on binder and there is even more spillover I think, it looks like it does not use wrapping at all?
There was a problem hiding this comment.
This issue seems more complicated than I orginally thought, would you mind reverting here to 79 and opening an issue so that we can take the time to understand what's going on, and merge the rest of this PR?
There was a problem hiding this comment.
I think it is the custom dark theme that changes the width of the help box in the first screen shot (it looks like you have even more room on the right). I tried the default Jupyter Light and Dark theme and they both perform the wrapping as I indicated above:
On your binder screenshot, it appears as if you are running without PR #1835. I'm on jupyter 4.4.0 and jupyterlab 1.0.5.
There was a problem hiding this comment.
Do you prefer if I make a new commit that to revert the change, or can I drop the old one in a rebase and then force push?
There was a problem hiding this comment.
Thanks a lot for helping to document this. OK, so no need to revert the change, I'll merge as it is.
| @@ -461,6 +461,11 @@ def box( | |||
| """ | |||
| In a box plot, rows of `data_frame` are grouped together into a | |||
| box-and-whisker mark to visualize their distribution. | |||
| Each box spans from quartile 1 (Q1) to quartile 3 (Q3). The | |||
There was a problem hiding this comment.
could you please add a blank line before this sentence? The convention is to have a 1-line sentence to start the docstring, then if needed explanations in another paragraph.
| "If set, a vertical subplot is drawn to the right of the main plot, visualizing the y-distribution.", | ||
| ], | ||
| trendline=[ | ||
| "str", | ||
| "One of `'rug'`, `'box'`, `'violin'`, `'histogram'`.", | ||
| "One of `'ols'` or `'lowess'`.", |
I noticed these minor issues while working on the other PRs.