Skip to content

[Python] Add section about supported substitutions to settings page. #3199

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

Closed
ericsnowcurrently opened this issue Oct 30, 2019 · 2 comments
Closed
Assignees
Labels
doc-enhancement suggested addition or improvement python

Comments

@ericsnowcurrently
Copy link
Contributor

ericsnowcurrently commented Oct 30, 2019

While VS Code does not support much variable substitution in settings, the Python extension does. However, I didn't find any mention of this in the extension's documentation. There is a "settings reference" page, but it doesn't say anything about substitution, other than the fact that some of the default values use the substitution syntax.

So a section on that page about supported variable substitution would be a useful addition, along with a one-sentence mention at the top of the page about that support (presumably the new section would be added to the bottom). I'd expect the new section to briefly explain how substitution works and then enumerate the supported variables. Since it's pretty much the same as what VS Code does, I expect it would be enough to give a brief summary, link to the VS Code docs, and show a minimal table.

Here are relevant details:

@ericsnowcurrently
Copy link
Contributor Author

@luabud

@gregvanl gregvanl added the doc-enhancement suggested addition or improvement label Nov 5, 2019
@JoshuaPartlow
Copy link
Contributor

@luabud @ericsnowcurrently - Updated with PR #3282. Please take a look and feel free to reopen if you think more is needed or something needs additional clarification.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc-enhancement suggested addition or improvement python
Projects
None yet
Development

No branches or pull requests

3 participants