Fix to auto-capitalization PR #888
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
emilyychenn
changed the title
…zation logic into [RenderBlockContent] and [RenderInlineContent] extensions.
emilyychenn
force-pushed
the
capitalize-first-word-fix
branch
from
125094e to
d7e487b
Compare
d-ronnqvist
reviewed
Apr 16, 2024
Sources/SwiftDocC/Model/Rendering/RenderSectionTranslator/DiscussionSectionTranslator.swift
Outdated
Show resolved
Hide resolved
Sources/SwiftDocC/Model/Rendering/RenderSectionTranslator/ParametersSectionTranslator.swift
Outdated
Show resolved
Hide resolved
Sources/SwiftDocC/Model/Rendering/RenderSectionTranslator/ReturnsSectionTranslator.swift
Outdated
Show resolved
Hide resolved
Sources/SwiftDocC/Model/Rendering/Content/RenderBlockContent+Capitalization.swift
Outdated
Show resolved
Hide resolved
… since this is a non-mutating function.
|
@swift-ci please test |
emilyychenn
added a commit
to emilyychenn/swift-docc
that referenced
this pull request
Apr 16, 2024
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.
emilyychenn
added a commit
that referenced
this pull request
Apr 19, 2024
* Auto-Capitalize First Word (#880) rdar://122167705 When writing a doc comment, it feels intuitive to not capitalize 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. --------- * Fix to auto-capitalization PR (#888) 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. --------- Co-authored-by: Pat Shaughnessy <[email protected]>
emilyychenn
added a commit
to emilyychenn/swift-docc
that referenced
this pull request
Apr 30, 2024
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.
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.
Bug/issue #, if applicable: rdar://122167705
Summary
Follow-up PR after #880. Notable changes:
withFirstWordCapitalizedfrom a computed property to a function namedcapitalizingFirstWord().[RenderBlockContent]and[RenderInlineContent]extensions.Dependencies
N/A
Testing
Add documentation via doc comments with anything after the colon (e.g. a parameter, aside, warning, important, todo, note, throws, returns) written in lowercase, then compile the documentation. The rendered documentation should now include an uppercased first character if the first word in the sentence is all lowercase and/or punctuation belonging to the CharacterSet punctuation characters.
Checklist
Make sure you check off the following items. If they cannot be completed, provide a reason.
./bin/testscript and it succeeded