Skip to content

Commit

Permalink
Clarify symbol uniqueness and signature_documentation.relative_path p…
Browse files Browse the repository at this point in the history
…resence
  • Loading branch information
mgsloan committed Dec 26, 2024
1 parent 94484d9 commit c811d76
Showing 1 changed file with 4 additions and 1 deletion.
5 changes: 4 additions & 1 deletion scip.proto
Original file line number Diff line number Diff line change
Expand Up @@ -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`.
Expand Down Expand Up @@ -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
Expand Down

0 comments on commit c811d76

Please sign in to comment.