Skip to content
This repository was archived by the owner on Nov 18, 2022. It is now read-only.

Misleading description for "rust-client.updateOnStartup" setting #407

Closed
Systemcluster opened this issue Aug 24, 2018 · 0 comments · Fixed by #789
Closed

Misleading description for "rust-client.updateOnStartup" setting #407

Systemcluster opened this issue Aug 24, 2018 · 0 comments · Fixed by #789
Milestone

Comments

@Systemcluster
Copy link

Systemcluster commented Aug 24, 2018

The setting is defined as:

"rust-client.updateOnStartup": {
	"type": "boolean",
    "default": false,
    "description": "Update the RLS whenever the extension starts up."
},

This option results in rustup updating the toolchain, not only the RLS component. In case of a nightly toolchain, this potentially uninstalls the RLS.

The comment should indicate that the setting results in updates of the toolchain. I would suggest to use a wording similar to the description of the rls.update command:

{
    "command": "rls.update",
    "title": "Update the RLS",
    "description": "Use Rustup to update Rust, the RLS, and required data",
    "category": "Rust"
},
@Systemcluster Systemcluster changed the title Misleading configuration comment Misleading description for "rust-client.updateOnStartup" setting Sep 5, 2018
@Xanewok Xanewok added this to the 0.7 milestone Apr 7, 2019
Xanewok added a commit to Xanewok/rls-vscode that referenced this issue May 6, 2020
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants