-
Notifications
You must be signed in to change notification settings - Fork 157
Consistently use kebab-case filenames for DocC articles #1765
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
|
|
@@ -42,16 +42,16 @@ their problems. | |||||
|
|
||||||
| ### Essentials | ||||||
|
|
||||||
| - <doc:DefiningTests> | ||||||
| - <doc:OrganizingTests> | ||||||
| - <doc:MigratingFromXCTest> | ||||||
| - <doc:defining-tests> | ||||||
| - <doc:organizing-tests> | ||||||
| - <doc:migrating-from-xctest> | ||||||
| - ``Test(_:_:)`` | ||||||
| - ``Test`` | ||||||
| - ``Suite(_:_:)`` | ||||||
|
|
||||||
| ### Test parameterization | ||||||
|
|
||||||
| - <doc:ParameterizedTesting> | ||||||
| - <doc:parameterized-testing> | ||||||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
| - ``Test(_:_:arguments:)-8kn7a`` | ||||||
| - ``Test(_:_:arguments:_:)`` | ||||||
| - ``Test(_:_:arguments:)-3rzok`` | ||||||
|
|
@@ -61,12 +61,12 @@ their problems. | |||||
|
|
||||||
| ### Behavior validation | ||||||
|
|
||||||
| - <doc:Expectations> | ||||||
| - <doc:expectations> | ||||||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
| - <doc:known-issues> | ||||||
|
|
||||||
| ### Test customization | ||||||
|
|
||||||
| - <doc:Traits> | ||||||
| - <doc:traits> | ||||||
|
|
||||||
| ### Value description and reflection | ||||||
|
|
||||||
|
|
@@ -76,4 +76,4 @@ their problems. | |||||
|
|
||||||
| ### Data collection | ||||||
|
|
||||||
| - <doc:Attachments> | ||||||
| - <doc:attachments> | ||||||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Following the example in the style guide, the filename should match the title of the page, so From the style guide:
|
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
|
|
@@ -94,4 +94,4 @@ As in normal code, comments on tests are generally most useful when they: | |||||
| - Provide useful information about the operation or motivation of a test | ||||||
|
|
||||||
| If a test is related to a bug or issue, consider using the ``Bug`` trait instead | ||||||
| of comments. For more information, see <doc:AssociatingBugs>. | ||||||
| of comments. For more information, see <doc:associating-bugs>. | ||||||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. As explained above, this should be |
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. As explained above, this should be |
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
|
|
@@ -61,7 +61,7 @@ func engineWorks() async { | |||||
| A bug's URL is passed as a string and must be parseable according to | ||||||
| [RFC 3986](https://www.ietf.org/rfc/rfc3986.txt). A bug's unique identifier | ||||||
| can be passed as an integer or as a string. For more information on the formats | ||||||
| recognized by the testing library, see <doc:BugIdentifiers>. | ||||||
| recognized by the testing library, see <doc:bug-identifiers>. | ||||||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
|
|
||||||
| ## Add titles to associated bugs | ||||||
|
|
||||||
|
|
||||||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. As explained above, this should be |
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. As explained above, this should be |
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. As explained above, this should be |
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. As explained above, this should be |
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. As explained above, this should be |
| Original file line number | Diff line number | Diff line change | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
|
@@ -82,7 +82,7 @@ concurrency safety: | |||||||||||||
| } | ||||||||||||||
|
|
||||||||||||||
| For more information about suites and how to declare and customize them, see | ||||||||||||||
| <doc:OrganizingTests>. | ||||||||||||||
| <doc:organizing-tests>. | ||||||||||||||
|
|
||||||||||||||
| ### Convert setup and teardown functions | ||||||||||||||
|
|
||||||||||||||
|
|
@@ -202,7 +202,7 @@ As with XCTest, the testing library allows test functions to be marked `async`, | |||||||||||||
| [`MainActor.run(resultType:body:)`](https://developer.apple.com/documentation/swift/mainactor/run(resulttype:body:)). | ||||||||||||||
|
|
||||||||||||||
| For more information about test functions and how to declare and customize them, | ||||||||||||||
| see <doc:DefiningTests>. | ||||||||||||||
| see <doc:defining-tests>. | ||||||||||||||
|
|
||||||||||||||
| ### Check for expected values and outcomes | ||||||||||||||
|
|
||||||||||||||
|
|
@@ -773,7 +773,7 @@ suite serially: | |||||||||||||
| } | ||||||||||||||
| } | ||||||||||||||
|
|
||||||||||||||
| For more information, see <doc:Parallelization>. | ||||||||||||||
| For more information, see <doc:parallelization>. | ||||||||||||||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||||||||||
|
|
||||||||||||||
| ### Attach values | ||||||||||||||
|
|
||||||||||||||
|
|
@@ -837,7 +837,7 @@ equivalent interface in Swift Testing. --> | |||||||||||||
|
|
||||||||||||||
| ## See Also | ||||||||||||||
|
|
||||||||||||||
| - <doc:DefiningTests> | ||||||||||||||
| - <doc:OrganizingTests> | ||||||||||||||
| - <doc:Expectations> | ||||||||||||||
| - <doc:defining-tests> | ||||||||||||||
| - <doc:organizing-tests> | ||||||||||||||
| - <doc:expectations> | ||||||||||||||
|
Comment on lines
+840
to
+842
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||||||||||
| - <doc:known-issues> | ||||||||||||||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. As explained above, this should be |
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. As explained above, this should be |
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. As explained above, this should be |
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
|
|
@@ -23,7 +23,7 @@ a test _case_. | |||||
|
|
||||||
| By default, the test cases of a test function run in parallel with each | ||||||
| other. For more information about test parallelization, see | ||||||
| <doc:Parallelization>. | ||||||
| <doc:parallelization>. | ||||||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
|
|
||||||
| ### Parameterize over an array of values | ||||||
|
|
||||||
|
|
||||||
| Original file line number | Diff line number | Diff line change | ||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
|
@@ -23,8 +23,8 @@ types that customize the behavior of your tests. | |||||||||||||||||
|
|
||||||||||||||||||
| ### Customizing runtime behaviors | ||||||||||||||||||
|
|
||||||||||||||||||
| - <doc:EnablingAndDisabling> | ||||||||||||||||||
| - <doc:LimitingExecutionTime> | ||||||||||||||||||
| - <doc:enabling-and-disabling> | ||||||||||||||||||
| - <doc:limiting-execution-time> | ||||||||||||||||||
|
Comment on lines
+26
to
+27
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||||||||||||||
| - ``Trait/enabled(if:_:sourceLocation:)`` | ||||||||||||||||||
| - ``Trait/enabled(_:sourceLocation:_:)`` | ||||||||||||||||||
| - ``Trait/disabled(_:sourceLocation:)`` | ||||||||||||||||||
|
|
@@ -34,15 +34,15 @@ types that customize the behavior of your tests. | |||||||||||||||||
|
|
||||||||||||||||||
| ### Running tests serially or in parallel | ||||||||||||||||||
|
|
||||||||||||||||||
| - <doc:Parallelization> | ||||||||||||||||||
| - <doc:parallelization> | ||||||||||||||||||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||||||||||||||
| - ``Trait/serialized`` | ||||||||||||||||||
|
|
||||||||||||||||||
| ### Annotating tests | ||||||||||||||||||
|
|
||||||||||||||||||
| - <doc:AddingTags> | ||||||||||||||||||
| - <doc:AddingComments> | ||||||||||||||||||
| - <doc:AssociatingBugs> | ||||||||||||||||||
| - <doc:BugIdentifiers> | ||||||||||||||||||
| - <doc:adding-tags> | ||||||||||||||||||
| - <doc:adding-comments> | ||||||||||||||||||
| - <doc:associating-bugs> | ||||||||||||||||||
| - <doc:bug-identifiers> | ||||||||||||||||||
|
Comment on lines
+42
to
+45
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||||||||||||||
| - ``Tag()`` | ||||||||||||||||||
| - ``Trait/bug(_:_:)`` | ||||||||||||||||||
| - ``Trait/bug(_:id:_:)-10yf5`` | ||||||||||||||||||
|
|
||||||||||||||||||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.