Skip to content

Commit 5fcfb85

Browse files
Show backticks in testing-doctest.md (#4941) (#4954)
(cherry picked from commit c527afc) Signed-off-by: Lantao Jin <ltjin@amazon.com> Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
1 parent ce8b452 commit 5fcfb85

1 file changed

Lines changed: 6 additions & 6 deletions

File tree

docs/dev/testing-doctest.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -75,12 +75,15 @@ For PPL documentation, Markdown format is now supported with the following guide
7575

7676
3. **Code Block Format**: Use **paired** fenced code blocks - each input block must be followed by its expected output block:
7777

78+
````text
7879
```ppl
7980
search source=accounts | where age > 25 | fields firstname, lastname
8081
```
82+
````
8183

8284
Expected output:
8385

86+
````text
8487
```text
8588
+-------------+------------+
8689
| firstname | lastname |
@@ -89,22 +92,19 @@ Expected output:
8992
| Hattie | Bond |
9093
+-------------+------------+
9194
```
95+
````
9296

9397
**Input/Output Pairs**: Each input code fence must be immediately followed by an "Expected output:" section with an output code fence
9498
- **Supported Input Languages**: `sql`, `ppl`, `bash`, `sh`, `bash ppl`
9599
- **Supported Output Languages**: `text`, `console`, `output`, `json`, `yaml`
96100

97101
4. **Ignoring Tests**: To skip specific code blocks from testing, add `ignore` attribute:
98102

103+
````text
99104
```ppl ignore
100105
search source=accounts | head 5
101106
```
102-
103-
Expected output:
104-
105-
```text
106-
This output won't be tested
107-
```
107+
````
108108

109109
5. **Validation**: Markdown categories only accept `.md` files - mixing with `.rst` files will cause validation errors
110110
6. **Testing**: Run `./gradlew doctest` to validate your markdown documentation

0 commit comments

Comments
 (0)