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

Run tidy on code snippets in documentation #13259

Open
aneeshusa opened this issue Sep 13, 2016 · 4 comments
Open

Run tidy on code snippets in documentation #13259

aneeshusa opened this issue Sep 13, 2016 · 4 comments
Labels

Comments

@aneeshusa
Copy link
Member

@aneeshusa aneeshusa commented Sep 13, 2016

For example, #13225 adds new shell code in a sh code fence markdown block. The review comment I made would have been caught by tidy in a regular shell file.

Note that there will probably need to be slight differences in tidy behavior, for example license headers are not required for snippets, shell snippets need not start with set -euo pipefail options, etc.

@aneeshusa aneeshusa added the L-python label Sep 13, 2016
@highfive
Copy link

@highfive highfive commented Sep 13, 2016

@leikahing
Copy link
Contributor

@leikahing leikahing commented Oct 26, 2016

I can handle this one as well.

@KiChjang
Copy link
Member

@KiChjang KiChjang commented Oct 26, 2016

You seem to have plenty of issues assigned to you already, do you mind finishing them off first before attempting this one?

@leikahing
Copy link
Contributor

@leikahing leikahing commented Oct 26, 2016

@KiChjang - sure thing. I do have an open PR waiting on @aneeshusa which is one of the two issues assigned to me right now.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Linked pull requests

Successfully merging a pull request may close this issue.

None yet
4 participants
You can’t perform that action at this time.