From 564fc161be00eb72b4f9785a67f06b8091f0b3bb Mon Sep 17 00:00:00 2001 From: Tom French Date: Fri, 4 Aug 2023 11:56:13 +0100 Subject: [PATCH] chore: add documentation to the `nargo lsp` command --- crates/nargo_cli/src/cli/lsp_cmd.rs | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/crates/nargo_cli/src/cli/lsp_cmd.rs b/crates/nargo_cli/src/cli/lsp_cmd.rs index afb824c5888..c35fcab96dc 100644 --- a/crates/nargo_cli/src/cli/lsp_cmd.rs +++ b/crates/nargo_cli/src/cli/lsp_cmd.rs @@ -12,6 +12,11 @@ use tower::ServiceBuilder; use super::NargoConfig; use crate::errors::CliError; +/// Starts the Noir LSP server +/// +/// Starts an LSP server which allows IDEs such as VS Code to display diagnostics in Noir source. +/// +/// VS Code Noir Language Support: https://marketplace.visualstudio.com/items?itemName=noir-lang.vscode-noir #[derive(Debug, Clone, Args)] pub(crate) struct LspCommand { #[clap(flatten)]