-
-
Notifications
You must be signed in to change notification settings - Fork 2k
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
Poor docstring formatting in vscode #2670
Comments
Hello, I'm a little new to open source development. I wanted to try this issue to learn a thing or two. Whats the process to be assigned it? |
Welcome @woefulpines! We don't normally bother with assignments in the Plotly open-source repos, you can just get started. Feel free to open a PR as soon as you have some progress to commit and mention this issue, so we know you're working on it and nobody duplicates your efforts. |
I was looking through the repository. I saw that some of the python generation had proper doc string formatting, I was a little confused as the doc string in the image provided doesn't match the template in the component generation in dash/development/ python component code gen file. I'll continue looking but any other perspective would be appreciated. Also, I was not able to recreate the issue and was wondering how I could get the same result. |
@woefulpines I think the components docstring are ok, it's in the callback docstring they are indented too much: Lines 84 to 134 in 508cce6
|
I'm sorry for the slow speed on this, I think I have a solution, but I was confused when it comes to opening a pull request. Would I need to apply for certain permissions to create a branch? |
@woefulpines what you wanna do is create a fork of the Dash repo in your own GitHub account. Then clone that and create a branch for your fix. Once you've made the commits your need in that branch, push the commits/branch to your fork on GitHub. You can then create a pull request in the Dash repo, requesting the branch from your fork to be merged into the Dash repo. This is a very common way to contribute to open source projects, so you should be able to find guides on how to do all those steps via Google etc |
Hello! Is this available to work on? |
Here's what it looks like for getting the docstring within
@callback
. Lots of white space and odd newline breaks. Could be nicer!The text was updated successfully, but these errors were encountered: