Skip to content

Dash Bio Python components require docstrings formatted like those from other libraries #378

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.

Sign up for GitHub

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

Jump to bottom
Closed
shammamah-zz opened this issue Jun 25, 2019 · 0 comments · Fixed by #379
Closed

Dash Bio Python components require docstrings formatted like those from other libraries #378

shammamah-zz opened this issue Jun 25, 2019 · 0 comments · Fixed by #379
Assignees
@shammamah-zz
Labels
housekeeping Issues that are unrelated to functionality (e.g., docstrings).
Milestone
0.1.3 release

Comments

@shammamah-zz
Copy link
Contributor

shammamah-zz commented Jun 25, 2019 •
edited
Loading

As of plotly/dash#782, the docstrings for components' props now look like this:

[prop name] ([type]; [required/optional/default [default value]]): [prop description]

The Clustergram, ManhattanPlot, and VolcanoPlot docstrings should be fixed accordingly.
@shammamah-zz shammamah-zz self-assigned this Jun 25, 2019
@shammamah-zz shammamah-zz mentioned this issue Jun 26, 2019
Merged
6 tasks
@shammamah-zz shammamah-zz added the housekeeping Issues that are unrelated to functionality (e.g., docstrings). label Jul 13, 2019
@shammamah-zz shammamah-zz added this to the 0.1.3 release milestone Jul 13, 2019
mkcor referenced this issue Jul 23, 2019
@mkcor
Standardize Clustergram code
39fec92
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@shammamah-zz shammamah-zz

Labels
housekeeping Issues that are unrelated to functionality (e.g., docstrings).
Projects
None yet
Milestone
0.1.3 release
Development

Successfully merging a pull request may close this issue.

Python docstrings refactoring plotly/dash-bio
1 participant
@shammamah-zz