Skip to content

docs: fix typos and copy-paste error in LSP/BSP comments - #68

Merged
hamishknight merged 1 commit into
swiftlang:mainfrom
Avicennasis:docs/fix-typos
Jun 23, 2026
Merged

docs: fix typos and copy-paste error in LSP/BSP comments#68
hamishknight merged 1 commit into
swiftlang:mainfrom
Avicennasis:docs/fix-typos

Conversation

@Avicennasis

Copy link
Copy Markdown
Contributor

Summary

Fix 13 documentation issues across 4 files in the LSP and BSP protocol types:

WorkDoneProgress.swift:

  • Fix "subsequent in report" → "subsequent report" (appeared in both WorkDoneProgressBegin and WorkDoneProgressReport)
  • Fix "don't support control the" → "don't support controlling the"
  • Fix "indicating to for example indicate" → "indicating, for example,"
  • Fix incorrect debugDescription in WorkDoneProgressEnd decoder: referenced WorkDoneProgressReport instead of WorkDoneProgressEnd

CompletionRequest.swift:

  • Fix "has trigger code complete" → "has triggered code completion"

SignatureHelpRequest.swift:

  • Fix "multiple signature but" → "multiple signatures but"
  • Fix "is ignore if" → "is ignored if"
  • Fix "as no signatures" → "has no signatures"

TaskFinishNotification.swift:

  • Fix extra backtick in `build/taskStart` reference
  • Fix "The was not included" → "The test was not included" in TestStatus.skipped
  • Fix trailing space before period in CompileReportData.originId deprecation comment
  • Add missing period to TestReportData.originId deprecation comment

No functional changes — all fixes are in doc comments except the debugDescription string correction in WorkDoneProgressEnd, which fixes a potentially misleading error message.

Fix 13 issues across LSP and BSP protocol type documentation:

- Fix "subsequent in report" → "subsequent report" in WorkDoneProgressBegin/Report
- Fix "don't support control" → "don't support controlling" in WorkDoneProgressReport
- Fix "indicating to for example indicate" → "indicating, for example," in WorkDoneProgressEnd
- Fix incorrect debug description "WorkDoneProgressReport" → "WorkDoneProgressEnd"
- Fix "has trigger code complete" → "has triggered code completion" in CompletionContext
- Fix "multiple signature" → "multiple signatures" in SignatureHelp
- Fix "is ignore if" → "is ignored if" in SignatureHelp
- Fix "as no signatures" → "has no signatures" in SignatureHelp
- Fix extra backtick in build/taskStart reference
- Fix "The was not" → "The test was not" in TestStatus.skipped
- Fix trailing space before period and missing period in Deprecated comments
@hamishknight
hamishknight merged commit 4414b47 into swiftlang:main Jun 23, 2026
53 checks passed
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

Successfully merging this pull request may close these issues.

2 participants