From 76c49ca6d2f06c3d634e5ff0ce087fccd2cd1d4a Mon Sep 17 00:00:00 2001 From: Bryan Parno Date: Mon, 2 Dec 2024 22:05:13 -0500 Subject: [PATCH] Add another caveat --- editors/code/README.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/editors/code/README.md b/editors/code/README.md index 29d5b2f7f2ac..a17f87c3a3f1 100644 --- a/editors/code/README.md +++ b/editors/code/README.md @@ -7,6 +7,12 @@ This extension is **experimental** and subject to change; some features are like At present, it works best on small, self-contained Verus projects. Anything more complex will likely fail. +**WARNING**: `verus-analyzer` expects you to "Open Folder..." on +a directory containing a standard Rust project layout and metadata (`Cargo.toml`) file. +`verus-analyzer` scans the project root (`src/lib.rs` or `src/main.rs`) and all files +that are reachable from the root. If the file you are working on is not +reachable from the project root, most of the IDE features like "Go to Definition" will not work. + ## Verus-specific Features - Support for Verus syntax