Skip to content

Commit a7a8050

Browse files
committed
AG-55306 fix docs
* commit '71a015125011e86637ffc7a884df6c478c863162': fix src docs about-scriptlets.md: Missing periods in json- documentation
2 parents f876415 + 71a0151 commit a7a8050

6 files changed

Lines changed: 22 additions & 22 deletions

File tree

src/scriptlets/evaldata-prune.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ import {
3030
* example.org#%#//scriptlet('evaldata-prune'[, propsToRemove [, obligatoryProps [, stack]]])
3131
* ```
3232
*
33-
* - `propsToRemove` — optional, string of space-separated properties to remove
33+
* - `propsToRemove` — optional, string of space-separated properties to remove.
3434
* - `obligatoryProps` — optional, string of space-separated properties
3535
* which must be all present for the pruning to occur
3636
* - `stack` — optional, string or regular expression that must match the current function call stack trace;

src/scriptlets/json-prune-fetch-response.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -77,8 +77,8 @@ import { type Source } from './scriptlets';
7777
* if regular expression is invalid it will be skipped.
7878
* - `mode` — optional, syntax mode selector.
7979
* Supported values:
80-
* - `legacy` — force the existing legacy path syntax
81-
* - `jsonpath` — force JSONPath syntax
80+
* - `legacy` — force the existing legacy path syntax;
81+
* - `jsonpath` — force JSONPath syntax.
8282
* If omitted, the scriptlet detects JSONPath automatically for clearly JSONPath-shaped expressions.
8383
*
8484
* > Note please that you can use wildcard `*` for chain property name,

src/scriptlets/json-prune-xhr-response.ts

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -59,22 +59,22 @@ import { type Source } from './scriptlets';
5959
*
6060
* <!-- markdownlint-enable line-length -->
6161
*
62-
* - `propsToRemove` — optional, string of space-separated properties to remove
62+
* - `propsToRemove` — optional, string of space-separated properties to remove.
6363
* In `jsonpath` mode only single JSONPath prune expression is supported.
6464
* - `obligatoryProps` — optional, string of space-separated properties
65-
* which must be all present for the pruning to occur
65+
* which must be all present for the pruning to occur.
6666
* - `propsToMatch` — optional, string of space-separated properties to match for extra condition; possible props:
6767
* - string or regular expression for matching the URL passed to `XMLHttpRequest.open()` call;
68-
* - colon-separated pairs `name:value` where
69-
* - `name` — string or regular expression for matching XMLHttpRequest property name
68+
* - colon-separated pairs `name:value` where:
69+
* - `name` — string or regular expression for matching XMLHttpRequest property name;
7070
* - `value` — string or regular expression for matching the value of the option
71-
* passed to `XMLHttpRequest.open()` call
71+
* passed to `XMLHttpRequest.open()` call.
7272
* - `stack` — optional, string or regular expression that must match the current function call stack trace;
73-
* if regular expression is invalid it will be skipped
73+
* if regular expression is invalid it will be skipped.
7474
* - `mode` — optional, syntax mode selector.
7575
* Supported values:
76-
* - `legacy` — force the existing legacy path syntax
77-
* - `jsonpath` — force JSONPath syntax
76+
* - `legacy` — force the existing legacy path syntax;
77+
* - `jsonpath` — force JSONPath syntax.
7878
* If omitted, the scriptlet detects JSONPath automatically for clearly JSONPath-shaped expressions.
7979
*
8080
* > Note please that you can use wildcard `*` for chain property name,

src/scriptlets/json-prune.js

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -47,18 +47,18 @@ import {
4747
* example.org#%#//scriptlet('json-prune'[, propsToRemove [, obligatoryProps [, stack [, mode]]]])
4848
* ```
4949
*
50-
* - `propsToRemove` — optional, string of space-separated properties to remove
50+
* - `propsToRemove` — optional, string of space-separated properties to remove.
5151
* In `jsonpath` mode only single JSONPath prune expression is supported.
5252
* - `obligatoryProps` — optional, string of space-separated properties
53-
* which must be all present for the pruning to occur
53+
* which must be all present for the pruning to occur.
5454
* In `jsonpath` mode this argument is ignored. Express such preconditions
5555
* directly in `propsToRemove` with leading JSONPath guards and filters.
5656
* - `stack` — optional, string or regular expression that must match the current function call stack trace;
57-
* if regular expression is invalid it will be skipped
57+
* if regular expression is invalid it will be skipped.
5858
* - `mode` — optional, syntax mode selector.
5959
* Supported values:
60-
* - `legacy` — force the existing legacy path syntax
61-
* - `jsonpath` — force JSONPath syntax
60+
* - `legacy` — force the existing legacy path syntax;
61+
* - `jsonpath` — force JSONPath syntax.
6262
* If omitted, the scriptlet detects JSONPath automatically only for clearly JSONPath-shaped expressions,
6363
* otherwise it falls back to legacy syntax.
6464
*

src/scriptlets/trusted-prune-inbound-object.js

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -33,12 +33,12 @@ import {
3333
* example.org#%#//scriptlet('trusted-prune-inbound-object', functionName[, propsToRemove [, obligatoryProps [, stack]]])
3434
* ```
3535
*
36-
* - `functionName` — required, the name of the function to trap, it must have an object as an argument
37-
* - `propsToRemove` — optional, string of space-separated properties to remove
36+
* - `functionName` — required, the name of the function to trap, it must have an object as an argument.
37+
* - `propsToRemove` — optional, string of space-separated properties to remove.
3838
* - `obligatoryProps` — optional, string of space-separated properties
39-
* which must be all present for the pruning to occur
39+
* which must be all present for the pruning to occur.
4040
* - `stack` — optional, string or regular expression that must match the current function call stack trace;
41-
* if regular expression is invalid it will be skipped
41+
* if regular expression is invalid it will be skipped.
4242
*
4343
* > Note please that you can use wildcard `*` for chain property name,
4444
* > e.g. `ad.*.src` instead of `ad.0.src ad.1.src ad.2.src`.

wiki/about-scriptlets.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1298,7 +1298,7 @@ example.org#%#//scriptlet('json-prune-xhr-response'[, propsToRemove[, obligatory
12981298

12991299
<!-- markdownlint-enable line-length -->
13001300

1301-
- `propsToRemove` — optional, string of space-separated properties to remove
1301+
- `propsToRemove` — optional, string of space-separated properties to remove.
13021302
In `jsonpath` mode only single JSONPath prune expression is supported.
13031303
- `obligatoryProps` — optional, string of space-separated properties
13041304
which must be all present for the pruning to occur
@@ -1427,7 +1427,7 @@ https://gitlab.com/eyeo/snippets/-/blob/main/source/behavioral/json-prune.js
14271427
example.org#%#//scriptlet('json-prune'[, propsToRemove [, obligatoryProps [, stack [, mode]]]])
14281428
```
14291429

1430-
- `propsToRemove` — optional, string of space-separated properties to remove
1430+
- `propsToRemove` — optional, string of space-separated properties to remove.
14311431
In `jsonpath` mode only single JSONPath prune expression is supported.
14321432
- `obligatoryProps` — optional, string of space-separated properties
14331433
which must be all present for the pruning to occur

0 commit comments

Comments
 (0)