Skip to content

Commit 6be3331

Browse files
authored
Add a note about compile-time diagnostics to the style guide. (#331)
This PR adds a paragraph explaining that compile-time diagnostics in the macro target should follow Swift's style guide. ### Checklist: - [x] Code and documentation should follow the style of the [Style Guide](https://github.com/apple/swift-testing/blob/main/Documentation/StyleGuide.md). - [x] If public symbols are renamed or modified, DocC references should be updated.
1 parent 608cfcd commit 6be3331

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

Documentation/StyleGuide.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -101,6 +101,12 @@ Or, when writing the abstract for an enumeration `Flavor`, you could write:
101101
To organize symbols under types, place them in topic groups organized by usage.
102102
Begin topic group headings inside types with a noun or noun phrase.
103103

104+
#### Writing compile-time diagnostics
105+
106+
The macro target of this package produces a number of different compile-time
107+
diagnostics. These diagnostics should be written according to the Swift style
108+
guide for compiler diagnostics [here](https://github.com/apple/swift/blob/main/docs/Diagnostics.md).
109+
104110
### Documentation
105111

106112
Documentation for the testing library should follow the

0 commit comments

Comments
 (0)