Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

invalid BeginDocumentationCommentWithOneLineSummary warning #924

Open
rauhul opened this issue Feb 8, 2025 · 1 comment
Open

invalid BeginDocumentationCommentWithOneLineSummary warning #924

rauhul opened this issue Feb 8, 2025 · 1 comment

Comments

@rauhul
Copy link
Member

rauhul commented Feb 8, 2025

  /// Open a scope enclosed by `"typewriter"` double-quotes.
  ///
  /// Closed by a ``EndTypewriterDoubleQuotes`` macro.
  ///
  /// __Example Usage__:
  ///   ```swift
  ///   BeginTypewriterDoubleQuotes()
  ///   "Hello, Swift!"
  ///   EndTypewriterDoubleQuotes()
  ///   ```
  public struct BeginTypewriterDoubleQuotes: MDocMacroProtocol {
    public static let kind = "Qo"
    public var arguments: [MDocASTNode]
    /// Creates a new `BeginTypewriterDoubleQuotes` macro.
    public init() {
      self.arguments = []
    }
  }

triggers: Tools/generate-manual/MDoc/MDocMacro.swift:1144:3: warning: [BeginDocumentationCommentWithOneLineSummary] terminate this sentence with a period: "Open a scope enclosed by "typewriter" double-quotes."

@ahoppen
Copy link
Member

ahoppen commented Feb 8, 2025

Synced to Apple’s issue tracker as rdar://144429143

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants