Various minor changes #138
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
Collaborator
amartini51
commented
May 25, 2023
amartini51
commented
- For Swift 5.9 beta, put the beta banner back and update prose
- Fix a link that broke due to a DocC change
- Improve the GitHub PR template
- Mark the grammar format conversion as an ignored commit for Git blame
- Add a file that lets Git log/diff show changes in chapter order
This reverts commit 6842700.
When building with recent versions of DocC, the version of this link that includes the apostrophe generates a correct link, but uses the literal <doc:...> text from the markdown as the text of that link, instead of using the section name.
Only people with commit access can start a build on the continuous integration server, and they should already know when one is needed. There's no reason to remind other contributors about a step that they can't actually do.
For more information, see the git-interpret-trailers(1) man page.
|
This PR might be easier to review one commit at a time, rather than by reading the overall diff, since it picks up a bunch of different minor changes. |
When building with the legacy RST-based pipeline, the version was included as a subtitle for the ePUB version, and in the navigation sidebar for the HTML version. DocC doesn't support ePUB output, or this kind of customization to the sidebar. This approach matches how we displayed the Swift version prior to using the RST-based pipeline, when TSPL was published on developer.apple.com and used [Tool J] and the corresponding pipeline. At that time, we included the Swift version at the end of the book's title.
krilnon
approved these changes
May 26, 2023
bjlanier
approved these changes
May 26, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in 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.