Skip to content

Commit 1bb3c51

Browse files
karthiknadigCopilot
andcommitted
docs: use platform-neutral glob examples (PR #495)
Keep configure diagnostics clear on Windows, macOS, and Linux with relative container-directory examples. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
1 parent d1449f7 commit 1bb3c51

2 files changed

Lines changed: 3 additions & 3 deletions

File tree

‎crates/pet/src/jsonrpc.rs‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -602,7 +602,7 @@ fn recursive_environment_patterns(patterns: &[PathBuf]) -> impl Iterator<Item =
602602
fn warn_for_recursive_environment_patterns(patterns: &[PathBuf]) {
603603
for pattern in recursive_environment_patterns(patterns) {
604604
warn!(
605-
"Recursive environmentDirectories pattern '{}' can make configure slow; prefer bounded container-directory patterns such as '/home/user/envs' or '/home/user/*/envs'",
605+
"Recursive environmentDirectories pattern '{}' can make configure slow; prefer non-recursive container-directory patterns such as 'envs' or '*/envs'",
606606
pattern.display()
607607
);
608608
}

‎docs/JSONRPC.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -83,8 +83,8 @@ interface ConfigureParams {
8383
*
8484
* Useful for VS Code so users can configure where they store virtual environments.
8585
*
86-
* Values identify directories that contain environments. Glob patterns are supported (e.g., `/home/user/envs`, `/home/user/*/envs`).
87-
* Avoid recursive patterns such as `/home/user/**/envs`: they can traverse large directory trees,
86+
* Values identify directories that contain environments. Glob patterns are supported (e.g., `envs`, `*/envs`).
87+
* Avoid recursive patterns such as `**/envs`: they can traverse large directory trees,
8888
* delay configure responses, and trigger client timeouts.
8989
*/
9090
environmentDirectories?: string[];

0 commit comments

Comments
 (0)