Skip to content

update api documentation #945

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

Merged
eleanorjboyd merged 1 commit into from
Oct 17, 2025
Merged

update api documentation #945

Show file tree
Hide file tree
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
7 changes: 3 additions & 4 deletions examples/sample1/src/api.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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;

}

/**
Expand Down Expand Up @@ -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.
Expand Down Expand Up @@ -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 }>;
Expand Down
5 changes: 3 additions & 2 deletions src/api.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 }>;
Expand Down
Loading