-
-
Notifications
You must be signed in to change notification settings - Fork 2.6k
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
Reformat docstrings #1835
Reformat docstrings #1835
Conversation
Param name and typ on first row with default in parentheses. Tuple for colref and colref_list.
Also format docstrings to 79 char width.
I'm note sure how to fix the Python2 related test errors, I believe unpacking operators have been available in Python for quote some time, so not sure why |
Thank you for your pull request, it is clearly an improvement, also in plain |
@emmanuelle I had to reformat one more thing for Python2 compatability and now all tests are passing! |
], | ||
dimensions=[ | ||
"(list of strings, names of columns in `data_frame`)", | ||
"Columns to be used in multidimensional visualization.", | ||
"list of str", |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think this is a colref_list_type
no? @emmanuelle thoughts?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
yes, correct, we forgot to update this one. @joelostblom would you mind making this change? Otherwise I can push a commit to your branch if you don't have the time. And then we'll merge :-)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@emmanuelle Updated!
This is pretty great, thank you! Modulo my one comment we can merge this :) |
The failed test seems unrelated. |
This is really nice work, thanks very much! 💃 |
@nicolaskruchten As per our discussion in plotly/plotly_express#154
I tried not making more changes than necessary so I didn't go after things like changing "numbers" to "int" or "float". I used
make_subplots.py
as a guide and tried to be consistent with the formatting there (with the one exception being dict that I changed there instead according to what seemed to be the most frequently used elsewhere in plotly).Please have a thorough look through since I might have missed some parenthesis somewhere.
Close plotly/plotly_express#154