[mlir:LSP] Add a doc blurb for code completion
authorRiver Riddle <riddleriver@gmail.com>
Wed, 20 Jul 2022 19:01:34 +0000 (12:01 -0700)
committerRiver Riddle <riddleriver@gmail.com>
Wed, 20 Jul 2022 19:02:13 +0000 (12:02 -0700)
This also gets used for the vscode extension documentation.

mlir/docs/Tools/MLIRLSP.md

index b54176e..bcea9e9 100644 (file)
@@ -58,6 +58,14 @@ any generated diagnostics in-place.
 
 ![IMG](/mlir-lsp-server/diagnostics.png)
 
+#### Code completion
+
+The language server provides suggestions as you type, offering completions for
+dialect constructs (such as attributes, operations, and types), block names, SSA
+value names, keywords, and more.
+
+![IMG](/mlir-lsp-server/code_complete.gif)
+
 #### Cross-references
 
 Cross references allow for navigating the use/def chains of SSA values (i.e.
@@ -368,6 +376,7 @@ The MLIR extension adds language support for the
 - go-to-definition and cross references
 - Detailed information when hovering over IR entities
 - Outline and navigation of symbols and symbol tables
+- Code completion
 - Live parser and verifier diagnostics
 
 [mlir-vscode features]: #