Skip to content

Commit 2e38198

Browse files
committed
docs: fix markdownlint issues in TESTING.md
- Add language specifier to code block (MD040) - Rename duplicate "How to Run" headings (MD024) - Remove trailing colons from anti-pattern headings (MD026)
1 parent 7525c69 commit 2e38198

1 file changed

Lines changed: 7 additions & 7 deletions

File tree

TESTING.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -273,7 +273,7 @@ go test -v ./types/... -run TestConvert
273273

274274
**Expected output:**
275275

276-
```
276+
```text
277277
=== RUN TestConvertToDefault
278278
--- PASS: TestConvertToDefault (0.00s)
279279
...
@@ -843,7 +843,7 @@ Controlled by `DGRAPH_UPGRADE_MAIN_ONLY` environment variable:
843843
- Includes specific cloud commits
844844
- Runs in scheduled CI (comprehensive but slow)
845845

846-
### How to Run
846+
### Running Upgrade Tests
847847

848848
**Run all upgrade tests:**
849849

@@ -1023,7 +1023,7 @@ func TestSomething(t *testing.T) {
10231023

10241024
### Anti-Patterns to Avoid
10251025

1026-
#### ❌ Don't use time.Sleep for synchronization:
1026+
#### ❌ Don't use time.Sleep for synchronization
10271027

10281028
```go
10291029
// BAD
@@ -1033,7 +1033,7 @@ time.Sleep(5 * time.Second) // Flaky!
10331033
require.NoError(t, c.HealthCheck(false)) // Wait for actual condition
10341034
```
10351035

1036-
#### ❌ Don't share mutable state between tests:
1036+
#### ❌ Don't share mutable state between tests
10371037

10381038
```go
10391039
// BAD
@@ -1045,7 +1045,7 @@ func TestX(t *testing.T) {
10451045
}
10461046
```
10471047

1048-
#### ❌ Don't depend on test execution order:
1048+
#### ❌ Don't depend on test execution order
10491049

10501050
```go
10511051
// BAD - Test2 depends on Test1 running first
@@ -1059,7 +1059,7 @@ func TestQuery(t *testing.T) {
10591059
}
10601060
```
10611061

1062-
#### ❌ Don't ignore errors in tests:
1062+
#### ❌ Don't ignore errors in tests
10631063

10641064
```go
10651065
// BAD
@@ -1172,7 +1172,7 @@ Go's native fuzzing generates random inputs to find crashes, panics, or unexpect
11721172

11731173
- `dql/parser_fuzz_test.go` - DQL query parser fuzzing
11741174

1175-
### How to Run
1175+
### Running Fuzz Tests
11761176

11771177
```bash
11781178
# Run fuzz test for 5 minutes

0 commit comments

Comments
 (0)