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.

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

Jump to bottom

QuickInputButtons namespace seems odd #55494

Closed
gregvanl opened this issue Jul 31, 2018 · 3 comments
Closed

QuickInputButtons namespace seems odd #55494

gregvanl opened this issue Jul 31, 2018 · 3 comments
Assignees
@chrmarti
Labels
bug Issue identified by VS Code Team member as probable bug quick-pick Quick-pick widget issues verified Verification succeeded
Milestone
July 2018

Comments

@gregvanl
Copy link

While reviewing the generated API from vscode.d.ts, I noticed the new QuickInputButtons namespace. It doesn't follow other vscode.d.ts namespace conventions (lower case names like "commands", "extensions", "workspace") and is very small containing only one interface QuickInputButton.

Should this namespace be removed and the QuickInputButton interface just be at the global level?
@chrmarti
Copy link
Contributor

chrmarti commented Aug 2, 2018

The interface and the namespace should both be top-level:
image

The intend is for QuickInputButtons to have a (growing) set of predefined buttons. We could have made it a class with static fields, but @jrieken suggested to go with the namespace because that has advantages for documentation (I forgot which).

Does this cause any trouble?

@chrmarti chrmarti added the quick-pick Quick-pick widget issues label Aug 2, 2018
@gregvanl
Copy link
Author

gregvanl commented Aug 2, 2018

Mostly I brought this up since it is a change in convention with the other namespaces. The difference is very visible in the auto-generated API documentation:

image

@chrmarti
Copy link
Contributor

chrmarti commented Aug 3, 2018

I'll change it to a class with a static field. That will be in line with others like ThemeIcon.

@chrmarti chrmarti added the bug Issue identified by VS Code Team member as probable bug label Aug 3, 2018
@chrmarti chrmarti added this to the July 2018 milestone Aug 3, 2018
@aeschli aeschli added the verified Verification succeeded label Aug 3, 2018
@vscodebot vscodebot bot locked and limited conversation to collaborators Sep 17, 2018
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees

@chrmarti chrmarti

Labels
bug Issue identified by VS Code Team member as probable bug quick-pick Quick-pick widget issues verified Verification succeeded
Projects
None yet
Milestone
July 2018
Development

No branches or pull requests
3 participants
@aeschli @chrmarti @gregvanl