Commit 064abd1
authored
Convert the formal grammar for DocC compatibility (#55)
DocC doesn't support subscripts, so instead of using subscript "opt" for
optionality, use a postfix question mark. Alternatives considered
included text like "OPT" or "(opt)" and Unicode subscript characters.
The former are hard to read and interrupt the flow of the grammar. The
latter render poorly because they're intended for phonetic annotation,
so the different letters don't share a baseline in many fonts.
It's a known issue that DocC doesn't support hard breaks [1], so insert a
paragraph break between each grammar production for now. I added a
"double" paragraph break between groups, where there used to be a blank
line, to preserve that information for when DocC adds hard break support
in the future.
1: https://github.com/apple/swift-docc/issues/412
Fixes #3
Fixes rdar://101001280File tree
11 files changed
+3294
-1170
lines changed- Sources/TSPL/TSPL.docc
- ReferenceManual
11 files changed
+3294
-1170
lines changedLines changed: 11 additions & 20 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
22 | 22 | | |
23 | 23 | | |
24 | 24 | | |
25 | | - | |
| 25 | + | |
26 | 26 | | |
27 | 27 | | |
28 | 28 | | |
29 | 29 | | |
30 | 30 | | |
31 | 31 | | |
32 | 32 | | |
33 | | - | |
| 33 | + | |
34 | 34 | | |
35 | 35 | | |
36 | 36 | | |
37 | | - | |
38 | | - | |
39 | | - | |
40 | | - | |
41 | | - | |
42 | | - | |
| 37 | + | |
| 38 | + | |
| 39 | + | |
43 | 40 | | |
44 | 41 | | |
45 | 42 | | |
46 | 43 | | |
47 | 44 | | |
48 | 45 | | |
49 | 46 | | |
50 | | - | |
51 | | - | |
52 | | - | |
53 | | - | |
54 | | - | |
55 | | - | |
56 | | - | |
57 | | - | |
58 | | - | |
59 | | - | |
60 | | - | |
61 | | - | |
| 47 | + | |
| 48 | + | |
| 49 | + | |
| 50 | + | |
| 51 | + | |
| 52 | + | |
62 | 53 | | |
63 | 54 | | |
64 | 55 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
2237 | 2237 | | |
2238 | 2238 | | |
2239 | 2239 | | |
2240 | | - | |
2241 | | - | |
2242 | | - | |
2243 | | - | |
2244 | | - | |
2245 | | - | |
2246 | | - | |
2247 | | - | |
2248 | | - | |
2249 | | - | |
2250 | | - | |
2251 | | - | |
2252 | | - | |
2253 | | - | |
2254 | | - | |
| 2240 | + | |
| 2241 | + | |
| 2242 | + | |
| 2243 | + | |
| 2244 | + | |
| 2245 | + | |
| 2246 | + | |
| 2247 | + | |
| 2248 | + | |
| 2249 | + | |
| 2250 | + | |
| 2251 | + | |
| 2252 | + | |
| 2253 | + | |
| 2254 | + | |
| 2255 | + | |
| 2256 | + | |
| 2257 | + | |
| 2258 | + | |
| 2259 | + | |
| 2260 | + | |
| 2261 | + | |
| 2262 | + | |
| 2263 | + | |
2255 | 2264 | | |
2256 | 2265 | | |
2257 | 2266 | | |
| |||
0 commit comments