feat: TLDR021: Command example should not begin or end in whitespace #310
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
5 tasks
kbdharun
approved these changes
Mar 21, 2024
* add tldr-lint dockerfile * Add docker build workflow * npm install -> npm ci * docker push workflow * fix docker publish wf syntax * insert missing tailing newline * tailing newline * improv: update Docker and CI files Signed-off-by: K.B.Dharun Krishna <kbdharunkrishna@gmail.com> * cleanup: update CI files Signed-off-by: K.B.Dharun Krishna <kbdharunkrishna@gmail.com> * improv: combine publish workflows Signed-off-by: K.B.Dharun Krishna <kbdharunkrishna@gmail.com> * ci: add names for CI workflows --------- Signed-off-by: K.B.Dharun Krishna <kbdharunkrishna@gmail.com> Co-authored-by: K.B.Dharun Krishna <kbdharunkrishna@gmail.com> Co-authored-by: Owen Voke <development@voke.dev>
Signed-off-by: K.B.Dharun Krishna <kbdharunkrishna@gmail.com>
Signed-off-by: K.B.Dharun Krishna <kbdharunkrishna@gmail.com>
* add tldr 020: spelling of "Note: " * extend tldr020 to command descriptions --------- Co-authored-by: K.B.Dharun Krishna <kbdharunkrishna@gmail.com>
kbdharun
reviewed
Apr 3, 2024
| @@ -78,7 +78,8 @@ TLDR016 | Label for information link should be spelled exactly `More informa | |||
| TLDR017 | Information link should be surrounded with angle brackets | |||
| TLDR018 | Page should only include a single information link | |||
| TLDR019 | Page should only include a maximum of 8 examples | |||
| TLDR020 | Label for additional notes should be spelled exactly `Note: ` | |||
| TLDR020 | Label for additional notes should be spelled exactly `Note:` (with a succeeding whitespace) | |||
There was a problem hiding this comment.
I rebased this PR and merged it (sorry VSCode added previous commits too; removed them in the final commit message). To avoid the Markdown lint error, I replaced the space after Note: with a description. But I have left it as it is in the JS file.
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.
closes #293
This check will now lint cases in which example commands start with a space or end in an unescaped space.