-
Notifications
You must be signed in to change notification settings - Fork 65.5k
Workflow commands: Minor tweaks to example formatting, syntax #28767
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
Conversation
Some of the code is needlessly wrapping, only because it uses over-long strings. (Also, the "random-color-generator" only returns "green", which isn't very random.)
Recent commit ee2816b added a note to the docs advising that it's safest to always treat variable names as case-sensitive. Good advice, so let's lead by example.
A couple of the example lines were indented with some strange invisible control characters; replace with ordinary spaces.
|
Thanks for opening this pull request! A GitHub docs team member should be by to give feedback soon. In the meantime, please check out the contributing guidelines. |
Automatically generated comment ℹ️This comment is automatically generated and will be overwritten every time changes are committed to this branch. The table contains an overview of files in the Content directory changesYou may find it useful to copy this table into the pull request summary. There you can edit it to share links to important articles or changes and to give a high-level overview of how the changes in your pull request support the overall goals of the pull request.
fpt: Free, Pro, Team |
|
Oh, well... turns out the ghae version wraps either way. Can't win 'em all. |
|
@ferdnyc Thanks so much for submitting a PR! We really appreciate all the details and the examples you provided! This will make it easier to review 🎉 I'll get this triaged for review ⚡ |
skedwards88
left a comment
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 for this PR! We'll get this merged for you.
|
Thanks very much for contributing! Your pull request has been merged 🎉 You should see your changes appear on the site in approximately 24 hours. If you're looking for your next contribution, check out our help wanted issues ⚡ |
Why: The Workflow Commands documentation had some minor formatting issues
ALL_CAPSandlower_casefor the same variable name, which goes against the docs' own advice (added recently in ee2816b) that variables should be treated case-sensitively for safety.Each of these issues is addressed as a separate commit in the PR.
Closes: --
What's being changed (if available, include any code snippets, screenshots, or gifs):
A few of the example code-blocks in the "Workflow commands for GitHub Actions" document, to correct the issues listed above.
Four blocks similar to...
Old:
New:
...Because the shorter strings avoid wrapping, and also because "
echo green" is a pretty terrible implementation for a so-called "random color generator".One block with mixed variable case...
Old:
New:
Because the docs advise against doing exactly what the code was doing: mixing variable case.
Two code lines indented with control characters (non-breaking spaces?)
Diff view with visible whitespace and control-character display;
Check off the following:
I have reviewed my changes in staging, available via the View deployment link in this PR's timeline.
datadirectory.For content changes, I have completed the self-review checklist.