Add groupings for the various diagnostics #82002
Conversation
userdocs/diagnostics/diagnostics.md
Outdated
| - <doc:conformance-isolation> | ||
| - <doc:dynamic-callable-requirements> | ||
| - <doc:error-in-future-swift-version> | ||
| - <doc:existential-member-access-limitations> | ||
| - <doc:isolated-conformances> | ||
| - <doc:member-import-visibility> | ||
| - <doc:multiple-inheritance> | ||
| - <doc:mutable-global-variable> | ||
| - <doc:nominal-types> | ||
| - <doc:opaque-type-inference> | ||
| - <doc:property-wrapper-requirements> | ||
| - <doc:protocol-type-non-conformance> | ||
| - <doc:result-builder-methods> | ||
| - <doc:sendable-closure-captures> | ||
| - <doc:sending-closure-risks-data-race> | ||
| - <doc:sending-risks-data-race> | ||
| - <doc:string-interpolation-conformance> | ||
| - <doc:temporary-pointers> | ||
| - <doc:trailing-closure-matching> |
There was a problem hiding this comment.
Should we either generate this via a script or add a regression test to verify that all of the markdown files end up somewhere in this file?
There was a problem hiding this comment.
The former would be nice, though given we are grouping them we'd have to add something so that could happen automatically. But I can do the latter for now if that works for you.
userdocs/diagnostics/diagnostics.md
Outdated
| ## Diagnostics | ||
|
|
||
| Swift diagnostics are classified into errors and warnings. Warnings can only be silenced within |
There was a problem hiding this comment.
Assuming the omission of notes and remarks is intentional.
There was a problem hiding this comment.
Remarks partially since they have to be explicitly enabled. Notes I had in originally and am fine to add back, I removed them because you could see them as being just extra information. As above, happy to completely change this if you come up with something better.
|
|
||
| This diagnostic group includes errors and warnings pertaining to the `any` type | ||
| syntax. | ||
| `any` existential type syntax. |
There was a problem hiding this comment.
I would so much prefer the book to just call them existential. The "boxed" in "boxed protocol type" is overloaded and uncatchy, and the "protocol" is just not accurate.
bnbarham
force-pushed
the
update-feature-docs
branch
from
e01d720 to
00ab365
Compare
|
I imagine you'll all also be interested in swiftlang/swift-migration-guide#154 (which was my motivation for doing this in the first place - I wanted a link for upcoming features) |
Also make the titles and one line summaries a little more consistent (at least for diagnsotic groups and upcoming language features, haven't gone through the educational notes).
bnbarham
force-pushed
the
update-feature-docs
branch
from
614e434 to
32ec5a6
Compare
|
@swift-ci please smoke test |
1 similar comment
|
@swift-ci please smoke test |
|
I've updated to:
|
|
@swift-ci please smoke test Linux platform |
|
This is not a request for this PR, but I think we should have a |
These were meant to be part of swiftlang#82002, but forgot to add them.
These were meant to be part of swiftlang#82002, but forgot to add them.
These were meant to be part of swiftlang#82002, but forgot to add them.
Also make the titles and one line summaries a little more consistent (at least for diagnostic groups and upcoming language features, haven't gone through the educational notes).