-
Notifications
You must be signed in to change notification settings - Fork 139
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: Remove build:id
in generic examples
#596
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.
In this case I'd label them, yes, because it's otherwise hard to parse visually. BUT: I'd suggest taking the steps out of the comments entirely and having them in regular text, followed by the code example for that step. That way it's very clear (visually) to the user what the steps are when glancing over the docs, and they're only copying code comments into their system that are descriptive info reminding them of what the code does.
So you mean something like the following, instead of inlining the comments in the code:
uses: [email protected]
jobs:
id: bla |
Exactly. |
I've made the changes. Thank you both for the feedback. |
Thanks @olivekl ! |
No description provided.