Skip to content

Expand the 'Known Issues' documentation article#823

Merged
stmontgomery merged 4 commits into
swiftlang:mainfrom
stmontgomery:withKnownIssue-docs
Nov 19, 2024
Merged

Expand the 'Known Issues' documentation article#823
stmontgomery merged 4 commits into
swiftlang:mainfrom
stmontgomery:withKnownIssue-docs

Conversation

@stmontgomery

Copy link
Copy Markdown
Contributor

This expands the Known issues DocC article to give examples and describe several different ways it can be used.

Checklist:

  • Code and documentation should follow the style of the Style Guide.
  • If public symbols are renamed or modified, DocC references should be updated.

Resolves rdar://137961874

@stmontgomery stmontgomery added documentation 📚 Improvements or additions to documentation enhancement New feature or request issue-handling Related to Issue handling within the testing library labels Nov 13, 2024
@stmontgomery stmontgomery self-assigned this Nov 13, 2024
@stmontgomery

Copy link
Copy Markdown
Contributor Author

@swift-ci please test

@plemarquand plemarquand left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good stuff!

Comment thread Sources/Testing/Testing.docc/known-issues.md Outdated
See https://swift.org/CONTRIBUTORS.txt for Swift project authors
-->

Highlight known issues when running tests.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this specific phrasing came from our DevPubs friends? So you might want to ask them to look too.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've solicited feedback offline from @medreisbach @chuckdude @iamleeg

Comment thread Sources/Testing/Testing.docc/known-issues.md
Comment thread Sources/Testing/Testing.docc/known-issues.md Outdated
Comment thread Sources/Testing/Testing.docc/known-issues.md
#expect(foodTruck.grill.isHeating)
}
}
```

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do you want to add one more example showing all of the knobs and doodads in a single call?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 grynspan left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nitpicks only.

Comment thread Sources/Testing/Testing.docc/known-issues.md Outdated
Comment thread Sources/Testing/Testing.docc/known-issues.md Outdated
Comment thread Sources/Testing/Testing.docc/known-issues.md Outdated
@stmontgomery

Copy link
Copy Markdown
Contributor Author

@swift-ci please test

@stmontgomery stmontgomery merged commit ab18b73 into swiftlang:main Nov 19, 2024
@stmontgomery stmontgomery deleted the withKnownIssue-docs branch November 19, 2024 18:04
@grynspan grynspan added this to the Swift 6.x milestone Dec 5, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation 📚 Improvements or additions to documentation enhancement New feature or request issue-handling Related to Issue handling within the testing library

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants