Skip to content

Commit a82ce93

Browse files
committed
Merge branch 'main' of https://github.com/microsoft/vscode-docs into sync-public-docs
2 parents 7ae8e2d + 72e27c8 commit a82ce93

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

43 files changed

+212
-198
lines changed

api/extension-guides/language-model.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,7 @@ Once you've built the prompt for the language model, you first select the langua
7373

7474
To select the language model, you can specify the following properties: `vendor`, `id`, `family`, or `version`. Use these properties to either broadly match all models of a given vendor or family, or select one specific model by its ID. Learn more about these properties in the [API reference](/api/references/vscode-api#LanguageModelChat).
7575

76-
> **Note**: Currently, `gpt-4o`, `gpt-4o-mini`, `o1-preview`, `o1-mini`, `claude-3.5-sonnet`, `gemini-1.5-pro` are supported for the language model family. If you are unsure what model to use, we recommend `gpt-4o` for it's performance and quality. For interactions directly in the editor, we recommend `gpt-4o-mini` for it's performance.
76+
> **Note**: Currently, `gpt-4o`, `gpt-4o-mini`, `o1`, `o1-mini`, `claude-3.5-sonnet` are supported for the language model family. If you are unsure what model to use, we recommend `gpt-4o` for it's performance and quality. For interactions directly in the editor, we recommend `gpt-4o-mini` for it's performance.
7777
7878
If there are no models that match the specified criteria, the `selectChatModels` method returns an empty array. Your extension must appropriately handle this case.
7979

Lines changed: 2 additions & 2 deletions
Loading

api/language-extensions/programmatic-language-features.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ MetaDescription: Visual Studio Code language extensions contribute programming l
99

1010
# Programmatic Language Features
1111

12-
Programmatic Language Features is a set of smart-editing features powered by the [`vscode.languages.*`](/api/references/vscode-api#languages) API. There are two common ways to provide a dynamic language feature in Visual Studio Code. Let's take [Hover](#hover) as an example:
12+
Programmatic Language Features is a set of smart-editing features powered by the [`vscode.languages.*`](/api/references/vscode-api#languages) API. There are two common ways to provide a dynamic language feature in Visual Studio Code. Let's take [Hover](#show-hovers) as an example:
1313

1414
```ts
1515
vscode.languages.registerHoverProvider('javascript', {

api/references/commands.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -252,9 +252,12 @@ let success = await commands.executeCommand('vscode.openFolder', uri);
252252
* _context_ - An InlineValueContext
253253
* _(returns)_ - A promise that resolves to an array of InlineValue objects
254254

255-
`vscode.open` - Opens the provided resource in the editor.
255+
`vscode.open` - Opens the provided resource in the editor. Can be a text or binary file, or an http(s) URL. If you need more control over the options for opening a text file, use `vscode.window.showTextDocument` instead.
256256

257-
* _Uri_ -
257+
* _uri_ - Uri of a text or binary file, or an http(s) URL
258+
* _columnOrOptions_ - (optional) Either the column in which to open, or editor options, see `vscode.TextDocumentShowOptions`
259+
* _label_ - Editor label (optional)
260+
* _(returns)_ - no result
258261

259262
`vscode.openWith` - Opens the provided resource with a specific editor.
260263

Lines changed: 3 additions & 0 deletions
Loading

api/ux-guidelines/notifications.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -69,6 +69,26 @@ When needing to display progress for an indeterminate timeframe (for example, se
6969

7070
*This example uses the progress notification to show the setup involved for a remote connection, while also providing a link to the output logs (**details**).*
7171

72+
## Modal dialog
73+
74+
When you need immediate user input for an action, you can opt to show a modal dialog. This UI element should be used with caution because a modal dialog blocks user interactions outside the dialog, until it's dismissed.
75+
76+
![Modal dialog](images/examples/save-ai-generated-changes-dialog.png)
77+
78+
*This dialog appears after moving a JavaScript/TypeScript file, asking to update import statements in other files.*
79+
80+
**✔️ Do**
81+
82+
* Only use modal dialogs if you need immediate user interaction
83+
* Where appropriate, provide an action to avoid repeated user confirmation (*Always*/*Never* action)
84+
* Consider using a checkbox to remember the user's choice
85+
86+
**❌ Don't**
87+
88+
* Use modal dialogs to confirm multiple steps
89+
* Use modal dialogs for showing messages that don't require an action from the user
90+
* Show a modal dialog for actions that are not explicitly initiated by the user
91+
7292
## Links
7393

7494
* [Hello World extension sample](https://github.com/microsoft/vscode-extension-samples/tree/main/helloworld-sample)

blogs/2024/12/18/blog-video-v2.mp4

-8.19 MB
Binary file not shown.

blogs/2024/12/18/ccdt-commit-msgs.mp4

-216 KB
Binary file not shown.

blogs/2024/12/18/copilot-free.jpg

Lines changed: 3 additions & 0 deletions
Loading
-428 KB
Binary file not shown.

0 commit comments

Comments
 (0)