docs: Improve check_sample examples, add general comments #1039
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Please check if General Comments make sense! |
jfagoagas
requested changes
Feb 10, 2022
checks/check_sample
Outdated
| @@ -36,38 +36,68 @@ | |||
| # CHECK_DOC_checkN="" | |||
| # CHECK_CAF_EPIC_checkN="" | |||
|
|
|||
| # General comments | |||
| # ---------------- | |||
| # Do not add double quotes (") arround variable ${PROFILE_OPT} | |||
There was a problem hiding this comment.
Suggested change
| # Do not add double quotes (") arround variable ${PROFILE_OPT} | |
| # Do not add double quotes (") arround variable ${PROFILE_OPT} because this variable holds "--profile <profile-name>" and we need to read it as it is. |
| # - ${var:N} : Return string from position 'N' | ||
| # - ${var:N:len} : Return 'len' characters from position 'N' | ||
| # - ${var^^} : Convert to upper-case all characters | ||
| # - ${var,,} : Convert to lower-case all characters |
There was a problem hiding this comment.
Suggested change
| # - ${var,,} : Convert to lower-case all characters | |
| # - ${var,,} : Convert to lower-case all characters | |
| # - For more examples and how to use it please refer to https://www.gnu.org/software/bash/manual/bash.html#Shell-Parameter-Expansion |
jfagoagas
added
the
status/waiting-for-revision
toniblyx
approved these changes
Feb 10, 2022
jfagoagas
approved these changes
Feb 10, 2022
This pull request was closed.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Context
A lot of checks are failing due to the lack of error handling.
Also some best practices are being required on PR revision.
Description
Improve examples to fit them into the best practice and to pass most of ShellCheck.
Add general comments about what/how to do.
License
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.