apple / sourcekit-lsp

Language Server Protocol implementation for Swift and C-based languages

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Bullets in doc comments rendered as "Discussion," labels are dropped.

dabrahams opened this issue · comments

For example, in all clients I can get my hands on:

  /// Returns a sequence whose elements describe each rule being recognized at
  /// `position`, where the rule started, and how many of its RHS symbols have
  /// been recognized.
  ///
  /// - Precondition: no other progress report for `self` exists.

The precondition is rendered as

Discussion

no other progress report for self exists.

Which is really misleading. Even if “Discussion” is unavoidable, the bullet label should be preserved (perhaps unless it is exactly “Discussion”)

Tracked in Apple’s issue tracker as rdar://120685874