suyiiyii/yq
1
0
Fork 0
mirror of https://github.com/mikefarah/yq.git synced 2025-01-23 14:16:10 +00:00
Code Issues Packages Projects Releases Wiki Activity

Fixing string docs

Browse Source
This commit is contained in:
Mike Farah 2022-04-01 13:21:55 +11:00
parent 5d225b9454
commit 523b8335d8
2 changed files with 8 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
pkg/yqlib/doc/operators/headers/string-operators.md
View File

@ -1,7 +1,9 @@
# String Operators # String Operators
## RegEx ## RegEx
This uses golangs native regex functions under the hood - See https://github.com/google/re2/wiki/Syntax for the supported syntax. This uses golangs native regex functions under the hood - See their [docs](https://github.com/google/re2/wiki/Syntax) for the supported syntax.
Case insensitive tip: prefix the regex with `(?i)` - e.g. `test("(?i)cats)"`.
### match(regEx) ### match(regEx)
This operator returns the substring match details of the given regEx. This operator returns the substring match details of the given regEx.
@ -9,7 +11,7 @@ This operator returns the substring match details of the given regEx.
### capture(regEx) ### capture(regEx)
Capture returns named RegEx capture groups in a map. Can be more convenient than `match` depending on what you are doing. Capture returns named RegEx capture groups in a map. Can be more convenient than `match` depending on what you are doing.
# test(regEx) ## test(regEx)
Returns true if the string matches the RegEx, false otherwise. Returns true if the string matches the RegEx, false otherwise.
## sub(regEx, replacement) ## sub(regEx, replacement)

6
pkg/yqlib/doc/operators/string-operators.md
View File

@ -1,7 +1,9 @@
# String Operators # String Operators
## RegEx ## RegEx
This uses golangs native regex functions under the hood - See https://github.com/google/re2/wiki/Syntax for the supported syntax. This uses golangs native regex functions under the hood - See their [docs](https://github.com/google/re2/wiki/Syntax) for the supported syntax.
Case insensitive tip: prefix the regex with `(?i)` - e.g. `test("(?i)cats)"`.
### match(regEx) ### match(regEx)
This operator returns the substring match details of the given regEx. This operator returns the substring match details of the given regEx.
@ -9,7 +11,7 @@ This operator returns the substring match details of the given regEx.
### capture(regEx) ### capture(regEx)
Capture returns named RegEx capture groups in a map. Can be more convenient than `match` depending on what you are doing. Capture returns named RegEx capture groups in a map. Can be more convenient than `match` depending on what you are doing.
# test(regEx) ## test(regEx)
Returns true if the string matches the RegEx, false otherwise. Returns true if the string matches the RegEx, false otherwise.
## sub(regEx, replacement) ## sub(regEx, replacement)