Ignore sentence terminators inside quotes when applying the 'BeginDocumentationCommentWithOneLineSummary' option. #687
Conversation
…umentationCommentWithOneLineSummary' option
| if $0.element == "OpenQuote" { | ||
| isInsideQuotes = true | ||
| } else if $0.element == "CloseQuote" { | ||
| isInsideQuotes = false |
There was a problem hiding this comment.
I was going to point out that this won't handle nested quotes correctly, but it looks like the Foundation API itself doesn't categorize them correctly either:
func tags(_ text: String) {
var tokenRanges = [Range<String.Index>]()
let tags = text.linguisticTags(in: text.startIndex..<text.endIndex, scheme: NSLinguisticTagScheme.lexicalClass.rawValue, tokenRanges: &tokenRanges)
print(Array(tags))
}
tags("\"Hello 'world'\"")
// ["OpenQuote", "Interjection", "Whitespace", "OpenQuote", "Noun", "CloseQuote", "OpenQuote"]So an attempt to increment/decrement a nested quote count won't work as intended. In other words, I wanted to point it out but you don't need to change anything.
There was a problem hiding this comment.
Yes, this is entirely dependent on the behavior of the Foundation API.
And since linguisticTags is a deprecated API, it's unlikely that we'll see any improvements to it 🤔
The replacement, NaturalLanguage, works the same as linguisticTags, but I've migrated to it in case it's improved in the future.
| /// A set of `Diagnostic` that can answer the question 'was there an error?' in O(1). | ||
| struct TestSingleQuotes {} | ||
|
|
||
| /// A set of `Diagnostic` that can answer the question “was there an error?” in O(1). |
There was a problem hiding this comment.
Both this example and the one below use smart quotes. Can you add one with regular ASCII (straight) double quotes?
| @@ -11,6 +11,7 @@ | |||
| //===----------------------------------------------------------------------===// | |||
|
|
|||
| import Foundation | |||
| import NaturalLanguage | |||
There was a problem hiding this comment.
Please add #if os(macOS) around this import to match where it's used, since it won't exist on Linux.
TTOzzi
force-pushed
the
fix-BeginDocumentationCommentWithOneLineSummary
branch
from
9fac08c to
c0a3702
Compare
|
Thank you 😊 |
Resolve #669
When
SentenceTerminatoris present betweenOpenQuoteandCloseQuote, changed the filtering logic to ignore it and prevent it from being recognized as a new sentence.