Skip to content

Commit

Permalink
docs: add missing backticks in various parts of the documentation (#1…
Browse files Browse the repository at this point in the history
  • Loading branch information
lumirlumir authored Dec 24, 2024
1 parent 789edbb commit 5db226f
Show file tree
Hide file tree
Showing 4 changed files with 4 additions and 4 deletions.
2 changes: 1 addition & 1 deletion docs/src/extend/plugins.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ If you plan to distribute your plugin as an npm package, make sure that the modu

### Meta Data in Plugins

For easier debugging and more effective caching of plugins, it's recommended to provide a name and version in a `meta` object at the root of your plugin, like this:
For easier debugging and more effective caching of plugins, it's recommended to provide a `name` and `version` in a `meta` object at the root of your plugin, like this:

```js
const plugin = {
Expand Down
2 changes: 1 addition & 1 deletion docs/src/rules/id-match.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ rule_type: suggestion
Naming things consistently in a project is an often underestimated aspect of code creation.
When done correctly, it can save your team hours of unnecessary head scratching and misdirections.
This rule allows you to precisely define and enforce the variables and function names on your team should use.
No more limiting yourself to camelCase, snake_case, PascalCase, or HungarianNotation. Id-match has all your needs covered!
No more limiting yourself to camelCase, snake_case, PascalCase, or HungarianNotation. `id-match` has all your needs covered!

## Rule Details

Expand Down
2 changes: 1 addition & 1 deletion docs/src/rules/no-array-constructor.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ related_rules:
Use of the `Array` constructor to construct a new array is generally
discouraged in favor of array literal notation because of the single-argument
pitfall and because the `Array` global may be redefined. The exception is when
the Array constructor is used to intentionally create sparse arrays of a
the `Array` constructor is used to intentionally create sparse arrays of a
specified size by giving the constructor a single numeric argument.

## Rule Details
Expand Down
2 changes: 1 addition & 1 deletion docs/src/rules/no-console.md
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ console.error("Log an error level message.");

If you're using Node.js, however, `console` is used to output information to the user and so is not strictly used for debugging purposes. If you are developing for Node.js then you most likely do not want this rule enabled.

Another case where you might not use this rule is if you want to enforce console calls and not console overwrites. For example:
Another case where you might not use this rule is if you want to enforce `console` calls and not `console` overwrites. For example:

```js
/* eslint no-console: ["error", { allow: ["warn"] }] */
Expand Down

0 comments on commit 5db226f

Please sign in to comment.