From c811d76a33e8d5cdc7e9af3ddb5c9a363ec7803f Mon Sep 17 00:00:00 2001 From: Michael Sloan Date: Tue, 24 Dec 2024 00:31:08 -0700 Subject: [PATCH] Clarify symbol uniqueness and signature_documentation.relative_path presence --- scip.proto | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/scip.proto b/scip.proto index 59a05b7c..ba237e04 100644 --- a/scip.proto +++ b/scip.proto @@ -76,7 +76,8 @@ message Document { // This field is typed as a string to permit any programming language, including // ones that are not specified by the `Language` enum. string language = 4; - // (Required) Unique path to the text document. + // Unique path to the text document. Required for top-level documents, but + // should be empty for `SymbolInformation.signature_documentation` values. // // 1. The path must be relative to the directory supplied in the associated // `Metadata.project_root`. @@ -233,6 +234,8 @@ message Descriptor { message SymbolInformation { // Identifier of this symbol, which can be referenced from `Occurence.symbol`. // The string must be formatted according to the grammar in `Symbol`. + // This identifier must be unique within indexer output, unless it begins with + // `local `, in which case it must be unique within the `Document`. string symbol = 1; // (optional, but strongly recommended) The markdown-formatted documentation // for this symbol. Use `SymbolInformation.signature_documentation` to