Skip to content

Commit c827bd9

Browse files
authored
editors - fix API comments around ViewColumn (microsoft#158273)
1 parent f152032 commit c827bd9

File tree

1 file changed

+14
-16
lines changed

1 file changed

+14
-16
lines changed

src/vscode-dts/vscode.d.ts

Lines changed: 14 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -752,10 +752,10 @@ declare module 'vscode' {
752752
export interface TextDocumentShowOptions {
753753
/**
754754
* An optional view column in which the {@link TextEditor editor} should be shown.
755-
* The default is the {@link ViewColumn.Active active}, other values are adjusted to
756-
* be `Min(column, columnCount + 1)`, the {@link ViewColumn.Active active}-column is
757-
* not adjusted. Use {@linkcode ViewColumn.Beside} to open the
758-
* editor to the side of the currently active one.
755+
* The default is the {@link ViewColumn.Active active}. Columns that do not exist
756+
* will be created as needed up to the maximum of {@linkcode ViewColumn.Nine}.
757+
* Use {@linkcode ViewColumn.Beside} to open the editor to the side of the currently
758+
* active one.
759759
*/
760760
viewColumn?: ViewColumn;
761761

@@ -814,10 +814,10 @@ declare module 'vscode' {
814814
export interface NotebookDocumentShowOptions {
815815
/**
816816
* An optional view column in which the {@link NotebookEditor notebook editor} should be shown.
817-
* The default is the {@link ViewColumn.Active active}, other values are adjusted to
818-
* be `Min(column, columnCount + 1)`, the {@link ViewColumn.Active active}-column is
819-
* not adjusted. Use {@linkcode ViewColumn.Beside} to open the
820-
* editor to the side of the currently active one.
817+
* The default is the {@link ViewColumn.Active active}. Columns that do not exist
818+
* will be created as needed up to the maximum of {@linkcode ViewColumn.Nine}.
819+
* Use {@linkcode ViewColumn.Beside} to open the editor to the side of the currently
820+
* active one.
821821
*/
822822
readonly viewColumn?: ViewColumn;
823823

@@ -6178,8 +6178,6 @@ declare module 'vscode' {
61786178
* Denotes a location of an editor in the window. Editors can be arranged in a grid
61796179
* and each column represents one editor location in that grid by counting the editors
61806180
* in order of their appearance.
6181-
*
6182-
* Columns that do not exists will be created as needed up to the maximum of `ViewColumn.Nine`.
61836181
*/
61846182
export enum ViewColumn {
61856183
/**
@@ -6537,10 +6535,10 @@ declare module 'vscode' {
65376535
export interface TerminalEditorLocationOptions {
65386536
/**
65396537
* A view column in which the {@link Terminal terminal} should be shown in the editor area.
6540-
* Use {@link ViewColumn.Active active} to open in the active editor group, other values are
6541-
* adjusted to be `Min(column, columnCount + 1)`, the
6542-
* {@link ViewColumn.Active active}-column is not adjusted. Use
6543-
* {@linkcode ViewColumn.Beside} to open the editor to the side of the currently active one.
6538+
* The default is the {@link ViewColumn.Active active}. Columns that do not exist
6539+
* will be created as needed up to the maximum of {@linkcode ViewColumn.Nine}.
6540+
* Use {@linkcode ViewColumn.Beside} to open the editor to the side of the currently
6541+
* active one.
65446542
*/
65456543
viewColumn: ViewColumn;
65466544
/**
@@ -9451,8 +9449,8 @@ declare module 'vscode' {
94519449
* to control where the editor is being shown. Might change the {@link window.activeTextEditor active editor}.
94529450
*
94539451
* @param document A text document to be shown.
9454-
* @param column A view column in which the {@link TextEditor editor} should be shown. The default is the {@link ViewColumn.Active active}, other values
9455-
* are adjusted to be `Min(column, columnCount + 1)`, the {@link ViewColumn.Active active}-column is not adjusted. Use {@linkcode ViewColumn.Beside}
9452+
* @param column A view column in which the {@link TextEditor editor} should be shown. The default is the {@link ViewColumn.Active active}.
9453+
* Columns that do not exist will be created as needed up to the maximum of {@linkcode ViewColumn.Nine}. Use {@linkcode ViewColumn.Beside}
94569454
* to open the editor to the side of the currently active one.
94579455
* @param preserveFocus When `true` the editor will not take focus.
94589456
* @return A promise that resolves to an {@link TextEditor editor}.

0 commit comments

Comments
 (0)