-
-
Notifications
You must be signed in to change notification settings - Fork 2.1k
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
Update docstrings to address #1205 #1531
Conversation
As mentioned in plotly/dash-core-components#914 (comment), I think it would be a good idea to escape double quotes in the generated docstrings - even if the added period handles most cases where this would cause problems, the triple-quote potential issue remains. |
This looks really good! Such a relief to see all of this fixed. Glad we have test cases here with all of the types. Looks like the double quote issue was fixed, any other concerns here @alexcjohnson ? |
Oh, also we need a changelog entry. That and #1531 (comment) then I think this is ready to go! |
@harryturr this PR means the rest of the core will need to be included in the next release whether or not there's a changelog entry for each piece, so all the docstrings get rebuilt. |
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.
💃 Very nice work - big improvement to our docstrings!
Thanks for your kind words and assistance with this project! |
This PR updates how the docstrings are generated to address #1205
See more details in dash-docs #1063