Skip to content

Clarify description for viewId argument in vscode.openWith command #145270

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
lramos15 merged 5 commits into from
Oct 10, 2023
Merged

Clarify description for viewId argument in vscode.openWith command #145270

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
f3acc10
Update extHostApiCommands.ts
jruales Mar 16, 2022
9676867
Update extHostApiCommands.ts
jruales Mar 17, 2022
1d98b06
Update extHostApiCommands.ts
jruales Mar 17, 2022
9981b14
Update extHostApiCommands.ts
jruales Mar 17, 2022
22a7691
Merge branch 'main' into patch-2
jruales Oct 10, 2023
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
2 changes: 1 addition & 1 deletion src/vs/workbench/api/common/extHostApiCommands.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -411,7 +411,7 @@ const newCommands: ApiCommand[] = [
'vscode.openWith', '_workbench.openWith', 'Opens the provided resource with a specific editor.',
[
ApiCommandArgument.Uri.with('resource', 'Resource to open'),
ApiCommandArgument.String.with('viewId', 'Custom editor view id or \'default\' to use VS Code\'s default editor'),
ApiCommandArgument.String.with('viewId', 'Custom editor view id. This should be the viewType string for custom editors or the notebookType string for notebooks. Use \'default\' to use VS Code\'s default text editor'),
new ApiCommandArgument<vscode.ViewColumn | typeConverters.TextEditorOpenOptions | undefined, [vscode.ViewColumn?, ITextEditorOptions?] | undefined>('columnOrOptions', 'Either the column in which to open or editor options, see vscode.TextDocumentShowOptions',
v => v === undefined || typeof v === 'number' || typeof v === 'object',
v => !v ? v : typeof v === 'number' ? [typeConverters.ViewColumn.from(v), undefined] : [typeConverters.ViewColumn.from(v.viewColumn), typeConverters.TextEditorOpenOptions.from(v)],
Expand Down