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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Unclear wording #83508

Closed
jrieken opened this issue Oct 29, 2019 · 4 comments
Closed

Unclear wording #83508

jrieken opened this issue Oct 29, 2019 · 4 comments
Assignees
Labels
bug Issue identified by VS Code Team member as probable bug verified Verification succeeded
Milestone

Comments

@jrieken
Copy link
Member

jrieken commented Oct 29, 2019

re #83033

// If the command line argument does not have any values, simply assign
// it in the JSON below with a value of 'true'. Otherwise, put the value
// directly.

馃敐 that's quite hard to understand. unsure if should differentiate between switches and arguments? I would add a sample tho, e.g --disable-gpu becomes "disable-gpu": true, etc

@jrieken jrieken changed the title Unclear working Unclear wording Oct 29, 2019
@jrieken
Copy link
Member Author

jrieken commented Oct 29, 2019

Related to the description, I would add disable-gpu as commented out config value. So instead of

// If you see rendering issues in VSCode and have a better experience
// with software rendering, you can configure this by adding:
//
// 'disable-gpu': true

I would use

...
// NOTE: Changing this file requires a restart of VSCode.
{
  // Enabled by default by VSCode to resolve color issues in the renderer
  // See https://github.com/Microsoft/vscode/issues/51791 for details
  "disable-color-correct-rendering": true,

  // Use software rendering instead of GPU rendering. Often helps when seeing rendering issues.
  // 'disable-gpu': true
}

@bpasero
Copy link
Member

bpasero commented Oct 29, 2019

I think the documentation of the file is from a time where I thought I would support any kind of CLI args. This is no longer the case so I will update it.

@bpasero bpasero added the bug Issue identified by VS Code Team member as probable bug label Oct 29, 2019
@bpasero bpasero added this to the October 2019 milestone Oct 29, 2019
@bpasero
Copy link
Member

bpasero commented Oct 29, 2019

I think given the intellisense help, there is no need to explain how the file works. If we add another argument to this list, the JSON validation will make sure the user is typing the right thing.

New contents:

// This configuration file allows you to pass permanent command line arguments to VS Code.
// Only a subset of arguments is currently supported to reduce the likelyhood of breaking
// the installation.
//
// PLEASE DO NOT CHANGE WITHOUT UNDERSTANDING THE IMPACT
//
// NOTE: Changing this file requires a restart of VS Code.
{
	// Enabled by default by VS Code to resolve color issues in the renderer
	// See https://github.com/Microsoft/vscode/issues/51791 for details
	"disable-color-correct-rendering": true,

	// Use software rendering instead of hardware accelerated rendering.
	// This can help in cases where you see rendering issues in VS Code.
	// "disable-hardware-acceleration": true
}

@jrieken jrieken added the verified Verification succeeded label Oct 30, 2019
@jrieken
Copy link
Member Author

jrieken commented Oct 30, 2019

verified - tho it's a little unfortunate that all existing files (for insiders) aren't regenerated and hence unfixed

@vscodebot vscodebot bot locked and limited conversation to collaborators Dec 16, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
bug Issue identified by VS Code Team member as probable bug verified Verification succeeded
Projects
None yet
Development

No branches or pull requests

2 participants