Expand the 'Known Issues' documentation article #823
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Resolves rdar://137961874
stmontgomery added documentation stmontgomery requested review from SeanROlszewski, briancroom, dennisweissmann, grynspan and suzannaratcliff as code owners | @swift-ci please test |
grynspan reviewed Nov 13, 2024
| See https://swift.org/CONTRIBUTORS.txt for Swift project authors | ||
| --> | ||
| | ||
| Highlight known issues when running tests. |
There was a problem hiding this comment.
I think this specific phrasing came from our DevPubs friends? So you might want to ask them to look too.
There was a problem hiding this comment.
I've solicited feedback offline from @medreisbach @chuckdude @iamleeg
grynspan reviewed Nov 13, 2024
grynspan reviewed Nov 13, 2024
grynspan reviewed Nov 13, 2024
grynspan reviewed Nov 13, 2024
| #expect(foodTruck.grill.isHeating) | ||
| } | ||
| } | ||
| ``` |
There was a problem hiding this comment.
Do you want to add one more example showing all of the knobs and doodads in a single call?
There was a problem hiding this comment.
I'm going to decline to do this right now, mainly because the combinatorics make it difficult to have a coherent example. I could imagine offering more real-world examples in the future via some sort of example code repo/corpus.
grynspan reviewed Nov 19, 2024
grynspan reviewed Nov 19, 2024
grynspan reviewed Nov 19, 2024
| @swift-ci please test |
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit. This suggestion is invalid because no changes were made to the code. Suggestions cannot be applied while the pull request is closed. Suggestions cannot be applied while viewing a subset of changes. Only one suggestion per line can be applied in a batch. Add this suggestion to a batch that can be applied as a single commit. Applying suggestions on deleted lines is not supported. You must change the existing code in this line in order to create a valid suggestion. Outdated suggestions cannot be applied. This suggestion has been applied or marked resolved. Suggestions cannot be applied from pending reviews. Suggestions cannot be applied on multi-line comments. Suggestions cannot be applied while the pull request is queued to merge. Suggestion cannot be applied right now. Please check back later.
This expands the Known issues DocC article to give examples and describe several different ways it can be used.
Checklist:
Resolves rdar://137961874