Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Clarify SymbolInformation.symbol uniqueness properties and signature_documentation.relative_path presence #299

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Clarify SymbolInformation.symbol uniqueness properties and signature_documentation.relative_path presence #299

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion scip.proto
View file
Open in desktop
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