This repository has been archived by the owner on Mar 25, 2021. It is now read-only.
Improve failure message & docs for ban-comma-operator rule (#3380) #3384
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
ajafff
reviewed
Oct 23, 2017
src/rules/banCommaOperatorRule.ts
Outdated
| public static metadata: Lint.IRuleMetadata = { | ||
| ruleName: "ban-comma-operator", | ||
| description: "Bans the comma operator.", | ||
| description: "Disallows the comma operator to be used. [Read more about the comma operator here](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/Comma_Operator).", |
There was a problem hiding this comment.
In the rules list this text will be used as link to the rule's documentation page.
We should avoid putting a link inside another link.
Consider using descriptionDetails instead.
There was a problem hiding this comment.
Ah good point - I forgot about that! Just pushed a fix for this.
to avoid nested links in the docs index
ajafff
approved these changes
Oct 24, 2017
|
Thanks @ChrisMBarr |
HyphnKnight
pushed a commit
to HyphnKnight/tslint
that referenced
this pull request
Apr 9, 2018
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
PR checklist
Overview of change:
This improves the failure message, improves the description metadata, and adds rationale in the metadata for the
ban-comma-operatorbased on the discussions in #3380Is there anything you'd like reviewers to focus on?
CHANGELOG.md entry:
[enhancement]
ban-comma-operator- improved failure message and documentation