summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorBartek IwaƄczuk <biwanczuk@gmail.com>2020-11-06 17:36:28 +0100
committerGitHub <noreply@github.com>2020-11-06 17:36:28 +0100
commit280ab920a8129248f536d4a49b53d5c71ba340f1 (patch)
treebc17462ba084c47ea999411b49439d46966176eb
parentfd9b6e03af5ce8c8b78c2a0e71faa55a68890004 (diff)
docs: Update style guide (#8267)
-rw-r--r--docs/contributing/style_guide.md19
1 files changed, 5 insertions, 14 deletions
diff --git a/docs/contributing/style_guide.md b/docs/contributing/style_guide.md
index 9b75c09ba..3f190ecf3 100644
--- a/docs/contributing/style_guide.md
+++ b/docs/contributing/style_guide.md
@@ -279,20 +279,11 @@ the first column of the comment. For example:
Code examples should not contain additional comments. It is already inside a
comment. If it needs further comments it is not a good example.
-### Resolve linting problems using ESLint directives
+### Resolve linting problems using directives
-Currently, the building process uses ESLint to validate linting problems in the
-code. Don't use `deno_lint` directives while working with internal Deno code and
-the std library.
-
-What would be:
-
-```typescript
-// deno-lint-ignore no-explicit-any
-let x: any;
-```
-
-Should rather be:
+Currently, the building process uses `dlint` to validate linting problems in the
+code. If the task requires code that is non-conformant to linter use
+`deno-lint-ignore <code>` directive to supress the warning.
```typescript
// deno-lint-ignore no-explicit-any
@@ -300,7 +291,7 @@ let x: any;
```
This ensures the continuous integration process doesn't fail due to linting
-problems.
+problems, but it should be used scarcely.
### Each module should come with a test module.