Skip to content

Update docstrings to address #1205#1531

Merged
alexcjohnson merged 9 commits into
plotly:devfrom
AnnMarieW:update-docstrings
Feb 1, 2021
Merged

Update docstrings to address #1205#1531
alexcjohnson merged 9 commits into
plotly:devfrom
AnnMarieW:update-docstrings

Conversation

@AnnMarieW

Copy link
Copy Markdown
Collaborator

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

See more details in dash-docs #1063

@alexcjohnson

Copy link
Copy Markdown
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
Copy Markdown
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 ?

Comment thread dash/development/_py_components_generation.py Outdated
@alexcjohnson

Copy link
Copy Markdown
Collaborator

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

@alexcjohnson

Copy link
Copy Markdown
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.

Comment thread tests/unit/development/__init__.py Outdated

@alexcjohnson alexcjohnson left a comment

Copy link
Copy Markdown
Collaborator

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
Copy Markdown
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