[6.1] Cleaning recently changed docs #958
Merged
Conversation
This file contains 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
iamleeg
requested review from
stmontgomery,
grynspan,
dennisweissmann,
briancroom,
SeanROlszewski and
suzannaratcliff
as code owners
iamleeg
force-pushed
the
iamleeg/cherry-pick-docs-update
branch
from
972da83 to
c91343a
Compare
Improving the style and explanation of recent additions to the documentation. The recent changes to test traits are great, and come with some very nice documentation. I've done what I can to improve the style and the wording to make it easier to understand, and to make the style consistent with other documentation in the project. Changed the documentation for `Trait` and associated types. There are no behavioral changes in this PR, but I hope that the existing behavior is easier to use with better documentation. - [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.
iamleeg
force-pushed
the
iamleeg/cherry-pick-docs-update
branch
from
c91343a to
271f080
Compare
grynspan
changed the title
stmontgomery
added
documentation
briancroom
approved these changes
Feb 18, 2025
# for free
to join this conversation on GitHub.
Already have an account?
# to comment
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.
Explanation:
Documentation changes to Trait and related types.
Scope:
The changes are purely to documentation.
Issues:
rdar://143477064
Original PRs:
#924
Risk:
This PR only changes comments so there isn't any risk to the release.
Testing:
Tested by building documentation.
Reviewers:
@grynspan @briancroom