Skip to content
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.

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

Clarifying questions about tabs API JSDoc #145738

Closed
joyceerhl opened this issue Mar 22, 2022 · 2 comments
Closed

Clarifying questions about tabs API JSDoc #145738

joyceerhl opened this issue Mar 22, 2022 · 2 comments
Assignees
Labels
api insiders-released Patch has been released in VS Code Insiders polish Cleanup and polish issue workbench-tabs VS Code editor tab issues
Milestone

Comments

@joyceerhl
Copy link
Contributor

Testing #145585

  • When would a TabGroup have an undefined activeTab--would this be when the tab group is empty?
  • The docstring for isActive says this property is "Dictated by being the selected tab in the group", is there a difference between selected and active?
  • Should pinned tabs be closable by the close API, and should that be called out in the JSDoc?
  • The JSDoc for onDidChangeActiveTabGroup says "Whether it be which group is active." which I don't really understand
@lramos15
Copy link
Member

  • When would a TabGroup have an undefined activeTab--would this be when the tab group is empty?

Yes

  • The docstring for isActive says this property is "Dictated by being the selected tab in the group", is there a difference between selected and active?

I don't believe there is a distinction no. I also try to avoid a word in the property in its description as I feel it is similar to when a dictionary uses a word in the description of the word it's defining

  • Should pinned tabs be closable by the close API, and should that be called out in the JSDoc?

It should be, if not I'll take a look as most likely is a bug. Closing in the API is explicit and therefore we only prevent it in the case of data loss which pinning isn't

  • The JSDoc for onDidChangeActiveTabGroup says "Whether it be which group is active." which I don't really understand

Sounds like a semantic error. Thank you I'll take a look.

@joyceerhl
Copy link
Contributor Author

Yeah verified that pinned tabs can be closed with the close function (though isPinned is never true so not sure if addressing that will change this behavior)

@lramos15 lramos15 added polish Cleanup and polish issue api workbench-tabs VS Code editor tab issues labels Mar 22, 2022
@lramos15 lramos15 added this to the March 2022 milestone Mar 22, 2022
@github-actions github-actions bot locked and limited conversation to collaborators May 6, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
api insiders-released Patch has been released in VS Code Insiders polish Cleanup and polish issue workbench-tabs VS Code editor tab issues
Projects
None yet
Development

No branches or pull requests

3 participants
@lramos15 @joyceerhl and others