Skip to content

Commit f5b518c

Browse files
committed
docs: update Guided Tour examples for WDL 1.3
1 parent 3ef367f commit f5b518c

1 file changed

Lines changed: 29 additions & 11 deletions

File tree

guided-tour.md

Lines changed: 29 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -21,23 +21,41 @@ development. Sprocket contains both the `check` and `lint` (shortcut for `check
2121
You can see a list of all of the rules Sprocket contains by running `sprocket
2222
explain -h`. You can dive into any of the rules Sprocket includes by running
2323
`sprocket explain <RULE>`. For example, if we wanted to learn more about the
24-
`ImportSorted` rule, we could do the following.
24+
`ImportPlacement` rule, we could do the following.
2525

2626
```shell
27-
sprocket explain ImportSorted
27+
sprocket explain ImportPlacement
2828
```
2929

30-
This command gives the following description of the `ImportSorted` rule.
30+
This command gives the following description of the `ImportPlacement` rule.
3131

3232
```txt
33-
ImportSorted [Sorting]
34-
Ensures that imports are sorted lexicographically.
35-
36-
Imports should be sorted lexicographically to make it easier to find
37-
specific imports. This rule ensures that imports are sorted in a
38-
consistent manner. Specifically, the desired sort can be achieved
39-
with a GNU compliant `sort` and `LC_COLLATE=C`. No comments are
40-
permitted within an import statement.
33+
ImportPlacement [Clarity]
34+
Ensures that imports are placed between the version statement and any document items.
35+
36+
All import statements should follow the WDL version declaration with one empty line between the version and the first import statement.
37+
```
38+
39+
For example, this ordering triggers the rule:
40+
41+
```wdl
42+
version 1.3
43+
44+
workflow example {
45+
}
46+
47+
import "example2.wdl"
48+
```
49+
50+
Use this instead:
51+
52+
```wdl
53+
version 1.3
54+
55+
import "example2.wdl"
56+
57+
workflow example {
58+
}
4159
```
4260

4361
We encourage you to explore the existing validation and linting rules supported

0 commit comments

Comments
 (0)