Fix duplicate terminal punctuation in summary #1412
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
lsegal
reviewed
Jan 3, 2022
| if !@summary.empty? && @summary !~ /\A\s*\{include:.+\}\s*\Z/ | ||
| if !@summary.empty? && | ||
| @summary !~ /\A\s*\{include:.+\}\s*\Z/ && # Summary is copied using +{include:...}+ | ||
| @summary !~ /[!?]\s*\Z/ # Summary ends in a terminal punctuation |
There was a problem hiding this comment.
Seems like you probably want to include other punctuation marks here (: ; etc)
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.
Description
This PR prevents YARD from adding a period (
.) to the end of sentences that already end in a terminal punctuation character:.,?, or!.This is specially helpful for methods in Ruby that end with a
?, as they normally convey an interrogation:Completed Tasks
bundle exec rakelocally (if code is attached to PR).