Merge pull request #1371 from selfdocumentingcode/docs/extractor-target-default

Document default value for Extractor.on_property
This commit is contained in:
Mike Penz
2024-09-13 09:51:49 +02:00
committed by GitHub
+1 -1
View File
@@ -577,7 +577,7 @@ This applies to all configurations outlined in `Configuration Specification` and
| <parent>.method | The extraction method used. Defaults to: `replace`. Alternative values: `replaceAll`, `match`. These methods specified references the JavaScript String method. And a special method `regexr`, that functions similar to the `list` within the regexr tool. | | <parent>.method | The extraction method used. Defaults to: `replace`. Alternative values: `replaceAll`, `match`. These methods specified references the JavaScript String method. And a special method `regexr`, that functions similar to the `list` within the regexr tool. |
| <parent>.flags | Defines the regex flags specified for the pattern. Default: `gu`. | | <parent>.flags | Defines the regex flags specified for the pattern. Default: `gu`. |
| <parent>.on_empty | Defines the placeholder to be filled in, if the regex does not lead to a result. | | <parent>.on_empty | Defines the placeholder to be filled in, if the regex does not lead to a result. |
| <parent>.on_property | This is available for `Extractor` type regex objects. With the property describing a field available in PRs. (e.g.: title, body, ...) | | <parent>.on_property | This is available for `Extractor` type regex objects. With the property describing a field available in PRs. (e.g.: title, body, ...) Default: `body`. |
<details><summary><b>Example regex configuration block</b></summary> <details><summary><b>Example regex configuration block</b></summary>
<p> <p>