Skip to content

Commit 4fef873

Browse files
committed
Move comments outside note boxes.
The RST-to-markdown exporter had some special cases and some issues here, because RST and DocC-flavored markdown have different rules around what block level constructs can nest. Avoiding the nesting is the best option, when that's feasible.
1 parent 50956e2 commit 4fef873

File tree

2 files changed

+18
-19
lines changed

2 files changed

+18
-19
lines changed

Sources/TSPL/TSPL.docc/LanguageGuide/Concurrency.md

Lines changed: 12 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -316,19 +316,18 @@ you'll get compile-time error instead of introducing a bug.
316316
> return ["IMG001", "IMG99", "IMG0404"]
317317
> }
318318
> ```
319-
>
320-
>
321-
> <!--
322-
> - test: `sleep-in-toy-code`
323-
>
324-
> ```swifttest
325-
> >> struct Data {} // Instead of actually importing Foundation
326-
> -> func listPhotos(inGallery name: String) async throws -> [String] {
327-
> try await Task.sleep(until: .now + .seconds(2), clock: .continuous)
328-
> return ["IMG001", "IMG99", "IMG0404"]
329-
> }
330-
> ```
331-
> -->
319+
320+
<!--
321+
- test: `sleep-in-toy-code`
322+
323+
```swifttest
324+
>> struct Data {} // Instead of actually importing Foundation
325+
-> func listPhotos(inGallery name: String) async throws -> [String] {
326+
try await Task.sleep(until: .now + .seconds(2), clock: .continuous)
327+
return ["IMG001", "IMG99", "IMG0404"]
328+
}
329+
```
330+
-->
332331
333332
<!--
334333
TODO either add an example or maybe a short section

Sources/TSPL/TSPL.docc/LanguageGuide/Protocols.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2707,12 +2707,12 @@ print(differentNumbers.allEqual())
27072707
> Note: If a conforming type satisfies the requirements for multiple constrained extensions
27082708
> that provide implementations for the same method or property,
27092709
> Swift uses the implementation corresponding to the most specialized constraints.
2710-
>
2711-
> <!--
2712-
> TODO: It would be great to pull this out of a note,
2713-
> but we should wait until we have a better narrative that shows how this
2714-
> works with some examples.
2715-
> -->
2710+
2711+
<!--
2712+
TODO: It would be great to pull this out of a note,
2713+
but we should wait until we have a better narrative that shows how this
2714+
works with some examples.
2715+
-->
27162716

27172717
<!--
27182718
TODO: Other things to be included

0 commit comments

Comments
 (0)