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

Docstring generator is wrong for certain properties including sort_by #1205

Closed
nicolaskruchten opened this issue Apr 21, 2020 · 4 comments
Closed
Labels
bug something broken
Milestone

Comments

@nicolaskruchten
Copy link
Contributor

image

@Marc-Andre-Rivet
Copy link
Contributor

These entries are created by the generator, moving the issue to the Dash repo.

@Marc-Andre-Rivet Marc-Andre-Rivet transferred this issue from plotly/dash-table Apr 21, 2020
@chriddyp chriddyp changed the title Incorrect docs for sort_by Docstring generator is wrong: Incorrect docs for sort_by Apr 24, 2020
@chriddyp chriddyp added the bug something broken label Apr 24, 2020
@chriddyp
Copy link
Member

While we're in the neighborhood, I'm sure there are many more fixes that we can make for markdown readability. Here are a few blocks that are pretty tough to digest:

Missing some newlines in here? Especially to split up group and grouping
image

JS comment included in the default text
image

Nested dictionaries's lists aren't indendented
image

Could use some more newlines + same nested dictionary issue
image

null should be None
image

@chriddyp
Copy link
Member

Another related issue: https://github.com/plotly/dash-docs/issues/836

@Marc-Andre-Rivet Marc-Andre-Rivet added this to the OSS milestone Aug 4, 2020
@chriddyp chriddyp changed the title Docstring generator is wrong: Incorrect docs for sort_by Docstring generator is wrong for certain properties including sort_by Sep 11, 2020
AnnMarieW pushed a commit to AnnMarieW/dash that referenced this issue Jan 17, 2021
alexcjohnson added a commit that referenced this issue Feb 1, 2021
HammadTheOne pushed a commit to HammadTheOne/dash that referenced this issue May 28, 2021
HammadTheOne pushed a commit that referenced this issue Jul 23, 2021
@gvwilson
Copy link
Contributor

Hi - we are tidying up stale issues and PRs in Plotly's public repositories so that we can focus on things that are most important to our community. If this issue is still a concern, please add a comment letting us know what recent version of our software you've checked it with so that I can reopen it and add it to our backlog. (Please note that we will give priority to reports that include a short reproducible example.) If you'd like to submit a PR, we'd be happy to prioritize a review, and if it's a request for tech support, please post in our community forum. Thank you - @gvwilson

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug something broken
Projects
None yet
Development

No branches or pull requests

4 participants