Commit Graph

70 Commits

Author SHA1 Message Date
Owen Voorhees
22289b0bb2 Merge pull request #32231 from owenv/opaque-note
[EduNotes] Explain some opaque type diagnostics
2020-07-02 22:28:06 -07:00
Owen Voorhees
c69baa8731 [EduNotes] Explain some opaque type diagnostics 2020-07-01 21:04:16 -07:00
Onyekachi Ezeoke
38e2998e50 implement feedback changes 2020-07-01 04:04:03 +01:00
Onyekachi Ezeoke
42b9b48a06 update educational notes 2020-06-30 22:59:16 +01:00
Onyekachi Ezeoke
cbdb27464e add protocol self conformance exception note 2020-06-27 05:48:11 +01:00
Onyekachi Ezeoke
53b4ce0034 fix confusing protocol diagnostic
- update the diagnostic error message
- add educational notes
2020-06-27 05:48:11 +01:00
Owen Voorhees
6c646ec1fd Merge pull request #31649 from owenv/ephemeral-edu-notes
[Diagnostics] Add an edu note explaining @_nonEphemeral diags
2020-05-11 23:54:42 -05:00
Owen Voorhees
792fb87da5 [Diagnostics] Add an edu note explaining @_nonEphemeral diags 2020-05-11 13:05:12 -07:00
Zhiyu Zhu/朱智语
563c44f154 Fix typo in edu note on StringInterpolationProtocol 2020-05-10 21:42:13 -04:00
Zev Eisenberg
bf5ff50e8d Add syntax highlighting for GitHub. 2020-04-22 18:26:07 -04:00
Owen Voorhees
68530acb1d Add an edu note explaining StringInterpolationProtocol requirements 2020-04-20 14:41:08 -07:00
Owen Voorhees
cfbfadfb43 [Gardening] Standardize edu note markdown headers 2020-03-18 14:03:52 -07:00
swift-ci
3982bb4af7 Merge pull request #28612 from owenv/terminal_md_viewer 2020-03-12 18:55:45 -07:00
Owen Voorhees
72fba7db8a Merge pull request #30153 from owenv/protocol-can-only-be-used-as-a-constraint-because-it-has-self-or-associated-type-requirements-oh-no
[Diagnostics] Add edu note explaining limitations of protocols with assoc. type reqs.
2020-03-10 14:48:39 -07:00
Owen Voorhees
16e84e3c1c [Diagnostics] Add edu note explaining limitations of protocols with associated type requirements 2020-03-09 15:55:54 -07:00
Owen Voorhees
d68089dcf9 [Diagnostics] Add a basic terminal markdown printer for educational notes
Currently the printer only supports the subset of markdown used by
educational notes. It bolds headers, improves the appearance of lists
and horizontal rules, and does basic indenting of blockquotes and
code blocks.
2020-03-05 18:04:32 -08:00
Owen Voorhees
c75a363e1c Tweak @propertyWrapper diagnostics and add an educational note 2020-02-27 20:28:28 -08:00
Owen Voorhees
4e686494dc [Diagnostics] Add an educational note about @dynamicCallable requirements 2020-01-13 10:48:52 -06:00
Owen Voorhees
b84562003e [Diagnostics] Add an educational note explaining closure type inference rules
This note explains the difference in type inference between single expression and
non-single expression closures. It is associated with the "unable to infer
complex closure return type" diagnostic.
2019-12-04 13:37:11 -08:00
Owen Voorhees
ac05a66938 [Diagnostics] Introduce "Educational Notes" for diagnostics
Educational notes are small pieces of documentation which explain a concept
relevant to some diagnostic message. If -enable-descriptive-diagnostics is
passed, they will be printed after a diagnostic message if available.

Educational notes can be found at /usr/share/doc/diagnostics in a
toolchain, and are associated with specific compiler diagnostics in
EducationalNotes.def.
2019-11-07 13:18:35 -08:00