Skip to content

Commit

Permalink
docs: correct description of multiline patterns usage based on #1353 (#…
Browse files Browse the repository at this point in the history
  • Loading branch information
tatomyr authored Jan 4, 2024
1 parent fb46721 commit 7c7198d
Showing 1 changed file with 6 additions and 7 deletions.
13 changes: 6 additions & 7 deletions docs/rules/configurable-rules.md
Original file line number Diff line number Diff line change
Expand Up @@ -493,10 +493,9 @@ rules:
notPattern: /^The/
```

Take care using `notPattern` with multiline Markdown values such as
`description` fields. These may end with a newline rather than the character
you expect. Use the trimmed notations (`|-` or `>-`) or take account of this in
your pattern.
Take care using `notPattern` with multiline Markdown values such as `description` fields.
These may end with a newline or a space rather than the character you expect.
Use the [double-quoted style](https://yaml.org/spec/1.2.2/#731-double-quoted-style) or take account of this in your pattern.

### `pattern` example

Expand All @@ -512,9 +511,9 @@ rules:
pattern: /test/
```

Take care using `pattern` with multiline Markdown values such as `description`
fields. These may end with a newline rather than the character you expect. Use
the trimmed notations (`|-` or `>-`) or take account of this in your pattern.
Take care using `pattern` with multiline Markdown values such as `description` fields.
These may end with a newline or a space rather than the character you expect.
Use the [double-quoted style](https://yaml.org/spec/1.2.2/#731-double-quoted-style) or take account of this in your pattern.

### `ref` example

Expand Down

1 comment on commit 7c7198d

@github-actions
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Coverage report

St.
Category Percentage Covered / Total
🟡 Statements 76.31% 4100/5373
🟡 Branches 66.29% 2183/3293
🟡 Functions 68.42% 663/969
🟡 Lines 76.51% 3847/5028

Test suite run success

653 tests passing in 94 suites.

Report generated by 🧪jest coverage report action from 7c7198d

Please sign in to comment.