-
Notifications
You must be signed in to change notification settings - Fork 984
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
fix: minor edits to make dev docs a bit more clear #17382
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks a ton @lwasser!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Some nits inline, and lint needs to be addressed.
Head branch was pushed to by a user without write access
Co-authored-by: Mike Fiedler <miketheman@gmail.com>
Co-authored-by: Mike Fiedler <miketheman@gmail.com>
Co-authored-by: Mike Fiedler <miketheman@gmail.com>
Co-authored-by: Mike Fiedler <miketheman@gmail.com>
Co-authored-by: Mike Fiedler <miketheman@gmail.com>
@lwasser I fixed the linting errors for you here since there isn't a way to do this automatically. (FWIW, my editor is configured to automatically strip trailing whitespace, you might want to do the same in your editor! I just added the backticks manually). |
Ahhhh ok. thanks!! i'll look into adding that step in my editor! i'm so used to pre-commit doing it for me it never occurred to me to set something like that up! |
This also addresses #17374 . i ran into a bit of confusion setting up the dev environment. I thought I had to do it all using Docker but in the end I just discovered I can simply run make. I tried to make it clear to new contribs that they can skip the docker setup if they wish to contribute to the docs only!