From 8d697d9abc5fef9687db3a3be877e91794218ba5 Mon Sep 17 00:00:00 2001
From: eleanorjboyd <26030610+eleanorjboyd@users.noreply.github.com>
Date: Fri, 17 Oct 2025 13:20:33 -0700
Subject: [PATCH] update api documentation

---
 examples/sample1/src/api.ts | 7 +++----
 src/api.ts                  | 5 +++--
 2 files changed, 6 insertions(+), 6 deletions(-)

diff --git a/examples/sample1/src/api.ts b/examples/sample1/src/api.ts
index a23be902..689a85a3 100644
--- a/examples/sample1/src/api.ts
+++ b/examples/sample1/src/api.ts
@@ -650,7 +650,6 @@ export interface PythonProject {
      * The tooltip for the Python project, which can be a string or a Markdown string.
      */
     readonly tooltip?: string | MarkdownString;
-
 }
 
 /**
@@ -692,7 +691,6 @@ export interface PythonProjectCreator {
      */
     readonly tooltip?: string | MarkdownString;
 
-
     /**
      * Creates a new Python project or projects.
      * @param options - Optional parameters for creating the Python project.
@@ -1228,12 +1226,13 @@ export interface PythonEnvironmentVariablesApi {
      * 3. `.env` file at the root of the python project.
      * 4. `overrides` in the order provided.
      *
-     * @param uri The URI of the project, workspace or a file in a for which environment variables are required.
+     * @param uri The URI of the project, workspace or a file in a for which environment variables are required. If not provided,
+     * it fetches the environment variables for the global scope.
      * @param overrides Additional environment variables to override the defaults.
      * @param baseEnvVar The base environment variables that should be used as a starting point.
      */
     getEnvironmentVariables(
-        uri: Uri,
+        uri: Uri | undefined,
         overrides?: ({ [key: string]: string | undefined } | Uri)[],
         baseEnvVar?: { [key: string]: string | undefined },
     ): Promise<{ [key: string]: string | undefined }>;
diff --git a/src/api.ts b/src/api.ts
index c5c81865..0b60339b 100644
--- a/src/api.ts
+++ b/src/api.ts
@@ -1237,12 +1237,13 @@ export interface PythonEnvironmentVariablesApi {
      * 3. `.env` file at the root of the python project.
      * 4. `overrides` in the order provided.
      *
-     * @param uri The URI of the project, workspace or a file in a for which environment variables are required.
+     * @param uri The URI of the project, workspace or a file in a for which environment variables are required.If not provided,
+     * it fetches the environment variables for the global scope.
      * @param overrides Additional environment variables to override the defaults.
      * @param baseEnvVar The base environment variables that should be used as a starting point.
      */
     getEnvironmentVariables(
-        uri: Uri,
+        uri: Uri | undefined,
         overrides?: ({ [key: string]: string | undefined } | Uri)[],
         baseEnvVar?: { [key: string]: string | undefined },
     ): Promise<{ [key: string]: string | undefined }>;