Skip to content

docs: remove obsolete "larger than three" from TextEditor.viewColumn - #335335

Open
AManWhoCodes (amanx5) wants to merge 1 commit into
microsoft:mainfrom
amanx5:fix-viewcolumn-doc
Open

docs: remove obsolete "larger than three" from TextEditor.viewColumn#335335
AManWhoCodes (amanx5) wants to merge 1 commit into
microsoft:mainfrom
amanx5:fix-viewcolumn-doc

Conversation

@amanx5

Copy link
Copy Markdown

Fixes #335331

Description

In src/vscode-dts/vscode.d.ts, the JSDoc for TextEditor.viewColumn states:

/**
 * The column in which this editor shows. Will be `undefined` in case this
 * isn't one of the main editors, e.g. an embedded editor, or when the editor
 * column is larger than three.
 */
readonly viewColumn: ViewColumn | undefined;

The clause "or when the editor column is larger than three" is outdated legacy text from May 2018 (PR #49599) when ViewColumn only defined values up to Three.

As verified in #52315, textEditor.viewColumn is defined for any column in the grid layout, and ViewColumn.to(position) converts any EditorGroupColumn >= 0 to a ViewColumn. viewColumn is only undefined when the editor is not placed in a main editor group (e.g. embedded editors in Peek Views, inline widgets).

This PR removes the obsolete phrase.

Copilot AI balanced review requested due to automatic review settings September 9, 2026 19:10

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot wasn't able to review any files in this pull request.


💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Outdated JSDoc on TextEditor.viewColumn ("when the editor column is larger than three")

3 participants