[6.0] Auto-Capitalize first word #889
Merged
Conversation
This file contains hidden or 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
rdar://122167705 When writing a doc comment, it feels intuitive to not capitalise the first word of its description because of the nature of the doc comment. For example: adding a new parameter would be written as: `/// - Parameter testParam: this parameter is just a test parameter to show what this looks like in lowercase.` In this example, the sentence in doc comments is natural to write with a lowercase starting word, because the first word (Parameter) is already capitalized. This PR auto-capitalizes the first word of a new section or aside. Note that this auto-capitalization only occurs if the first word is all lowercase and contains only characters A-Z, or if the first word contains CharacterSet punctuation characters (e.g. a period, comma, hyphen, semi-colon, colon). This capitalization is also locale specific. --------- Co-authored-by: Pat Shaughnessy <[email protected]>
rdar://122167705 * Changed withFirstWordCapitalized from a computed property to a function. * Remove unused protocol and extension, and extracted repeated capitalization logic into [RenderBlockContent] and [RenderInlineContent] extensions. * Rename function from capitalizeFirstWord() to capitalizingFirstWord() since this is a non-mutating function.
|
@swift-ci please test |
franklinsch
approved these changes
Apr 18, 2024
|
@swift-ci please test |
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.
Explanation: When writing a doc comment, it feels intuitive to not capitalise the first word of its description because of the nature of the doc comment.
Scope: Developer experience — auto-capitalizes the first word.
Issue: rdar://122167705
Risk: Low, only risk is that developers don't like this change and would prefer taking control of their own capitalization.
Testing:
Reviewers: @patshaughnessy @daniel-grumberg @d-ronnqvist