Consistently use kebab-case filenames for DocC articles#1765
Consistently use kebab-case filenames for DocC articles#1765stmontgomery wants to merge 1 commit into
Conversation
stmontgomery
requested review from
briancroom,
grynspan,
harlanhaskins and
jerryjrchen
as code owners
stmontgomery
added
bug
mreid10
left a comment
mreid10
left a comment
There was a problem hiding this comment.
Based on the example given in the style guide, the kebab case filenames should align with the titles of the pages, most of my comments/suggestions are to get there.
For the files that we're changing the name of, we should also add @Redirected directives with the old path. For example, the Associating bugs with tests article which had the filename AssociatingBugs.md should have a redirected directive:
@Redirected(from:"documentation/testing/AssociatingBugs")
| See https://swift.org/LICENSE.txt for license information | ||
| See https://swift.org/CONTRIBUTORS.txt for Swift project authors | ||
| --> | ||
|
|
There was a problem hiding this comment.
We can also add a @Redirected directive to all the renamed files so DocC recognizes references to the old filename that we may have missed:
| @Redirected(from:"documentation/testing/AddingComments") |
There was a problem hiding this comment.
Following the example in the style guide, the filename should match the title of the page, so adding-comments-to-tests.md.
From the style guide:
For example, if the title of your article is Adding tags to tests, the
filename would beadding-tags-to-tests.md, or if the title of the collection
page is Event tags, the filename would beevent-tags.md.
There was a problem hiding this comment.
As explained above, this should be adding-tags-to-tests.md.
There was a problem hiding this comment.
As explained above, this should be associating-bugs-with-tests.md.
There was a problem hiding this comment.
As explained above, this should be interpreting-bug-identifiers.md.
| 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>. |
There was a problem hiding this comment.
| <doc:parallelization>. | |
| <doc:running-tests-serially-or-in-parallel>. |
| - <doc:defining-tests> | ||
| - <doc:organizing-tests> | ||
| - <doc:expectations> |
There was a problem hiding this comment.
| - <doc:defining-tests> | |
| - <doc:organizing-tests> | |
| - <doc:expectations> | |
| - <doc:defining-test-functions> | |
| - <doc:organizing-test-functions-with-suite-types> | |
| - <doc:expectations-and-confirmations> |
| } | ||
|
|
||
| For more information, see <doc:Parallelization>. | ||
| For more information, see <doc:parallelization>. |
There was a problem hiding this comment.
| For more information, see <doc:parallelization>. | |
| For more information, see <doc:running-tests-serially-or-in-parallel>. |
|
|
||
| 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>. |
There was a problem hiding this comment.
| of comments. For more information, see <doc:associating-bugs>. | |
| of comments. For more information, see <doc:associating-bugs-with-tests>. |
| [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>. |
There was a problem hiding this comment.
| recognized by the testing library, see <doc:bug-identifiers>. | |
| recognized by the testing library, see <doc:interpreting-bug-identifiers>. |
2 participants
Rename the DocC article files in
Testing.doccwhich currently use UpperCamelCase to use kebab-case instead, for the reasons explained in our style guide.Fixes #1758
Checklist: