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

Update docstrings to address #1205 #1531

Merged
merged 9 commits into from
Feb 1, 2021

Conversation

AnnMarieW
Copy link
Collaborator

This PR updates how the docstrings are generated to address #1205

See more details in dash-docs #1063

@alexcjohnson
Copy link
Collaborator

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.

@chriddyp
Copy link
Member

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 ?

@alexcjohnson
Copy link
Collaborator

Oh, also we need a changelog entry. That and #1531 (comment) then I think this is ready to go!

@alexcjohnson
Copy link
Collaborator

@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.

Copy link
Collaborator

@alexcjohnson alexcjohnson left a 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!

@alexcjohnson alexcjohnson merged commit 66c8451 into plotly:dev Feb 1, 2021
@AnnMarieW
Copy link
Collaborator Author

Thanks for your kind words and assistance with this project!

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.

5 participants