[PATCH] D115442: [clangd] Provide documentation as MarkupContent in signaturehelp

Sam McCall via Phabricator via cfe-commits cfe-commits at lists.llvm.org
Thu Dec 9 09:01:21 PST 2021


sammccall accepted this revision.
sammccall added a comment.
This revision is now accepted and ready to land.

MarkupContent was introduced in 3.12 in 2018.
We could continue to support older clients by rendering plaintext as string instead of the MarkupContent struct but it doesn't seem worth it.



================
Comment at: clang-tools-extra/clangd/Protocol.h:495
+  /// textDocument.signatureHelp.signatureInformation.documentationFormat
+  MarkupKind SignatureHelpDocumentationFormat = MarkupKind::PlainText;
 };
----------------
move next to other sighelp caps?


================
Comment at: clang-tools-extra/clangd/test/signature-help.test:1
 # RUN: clangd -lit-test < %s | FileCheck -strict-whitespace %s
 # Start a session.
----------------
I definitely don't think we need three copies of this test.

I'd personally probably only keep one, and have it specify markdown explicitly (plaintext is the default).
Keeping a test for both plain and markdown is more coverage, copied tests are a maintenance hazard, up to you.
Keeping both plain-explicitly-specified and plain-by-default seems gratuitous.


Repository:
  rG LLVM Github Monorepo

CHANGES SINCE LAST ACTION
  https://reviews.llvm.org/D115442/new/

https://reviews.llvm.org/D115442



More information about the cfe-commits mailing list