From c6e43c3cf369ca4e7849cbcf34798ac75066d20c Mon Sep 17 00:00:00 2001 From: Dominik Jain Date: Thu, 13 Nov 2025 11:46:53 +0100 Subject: [PATCH] Improve docstring --- src/solidlsp/ls.py | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/src/solidlsp/ls.py b/src/solidlsp/ls.py index 91ac8966..c64c05bd 100644 --- a/src/solidlsp/ls.py +++ b/src/solidlsp/ls.py @@ -133,7 +133,10 @@ class SolidLanguageServer(ABC): CACHE_FOLDER_NAME = "cache" RAW_DOCUMENT_SYMBOLS_CACHE_VERSION = 1 """ - global version identifier for raw symbol caches; an LS-specific version is defined separately and combined with this + global version identifier for raw symbol caches; an LS-specific version is defined separately and combined with this. + This should be incremented whenever there is a change in the way raw document symbols are stored. + If the result of a language server changes in a way that affects the raw document symbols, + the LS-specific version should be incremented instead. """ RAW_DOCUMENT_SYMBOL_CACHE_FILENAME = "raw_document_symbols.pkl" RAW_DOCUMENT_SYMBOL_CACHE_FILENAME_LEGACY_FALLBACK = "document_symbols_cache_v23-06-25.pkl"