LukeParke/redocly-cli
1
0
Fork 0
mirror of https://github.com/LukeHagar/redocly-cli.git synced 2025-12-06 04:21:09 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: correct description of multiline patterns usage based on #1353 (#1380)

Browse Source
This commit is contained in:
Andrew Tatomyr
2024-01-04 12:56:50 +02:00
committed by GitHub
parent fb46721d72
commit 7c7198d72e
1 changed files with 6 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
docs/rules/configurable-rules.md
View File

@@ -493,10 +493,9 @@ rules:
notPattern: /^The/ notPattern: /^The/
``` ```
Take care using `notPattern` with multiline Markdown values such as Take care using `notPattern` with multiline Markdown values such as `description` fields.
`description` fields. These may end with a newline rather than the character These may end with a newline or a space rather than the character you expect.
you expect. Use the trimmed notations (`|-` or `>-`) or take account of this in Use the [double-quoted style](https://yaml.org/spec/1.2.2/#731-double-quoted-style) or take account of this in your pattern.
your pattern.
### `pattern` example ### `pattern` example
@@ -512,9 +511,9 @@ rules:
pattern: /test/ pattern: /test/
``` ```
Take care using `pattern` with multiline Markdown values such as `description` Take care using `pattern` with multiline Markdown values such as `description` fields.
fields. These may end with a newline rather than the character you expect. Use These may end with a newline or a space rather than the character you expect.
the trimmed notations (`|-` or `>-`) or take account of this in your pattern. 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 ### `ref` example