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

[Python] Improve documentation for "request": "test" and "console": "integratedTerminal" #3742

Closed
lsorber opened this issue Jun 2, 2020 · 3 comments
Assignees
Labels
doc-enhancement suggested addition or improvement python

Comments

@lsorber
Copy link

lsorber commented Jun 2, 2020

Based on microsoft/vscode-python#12085, there is some unclarity regarding the launch.json options "request": "test" and "console": "integratedTerminal" in the Python documentation:

  1. The Python > Testing documentation [1] mentions that it's possible to add a launch configuration with "request": "test" to launch.json to configure the running and debugging of tests, but it doesn't explain what settings are possible or what they do. Specifically, it is not clear that "console": "integratedTerminal" changes the default behaviour to run and debug tests in the integrated terminal.

  2. The Python > Debugging documentation [2] does list the different options for the "console" setting in launch.json, but does not mention the possibility to configure the built-in debugger with "request": "test" (even though this is the debugging page).

[1] https://code.visualstudio.com/docs/python/testing#_debug-tests
[2] https://code.visualstudio.com/docs/python/debugging#_console

@gregvanl gregvanl added python doc-enhancement suggested addition or improvement labels Jun 2, 2020
@JoshuaPartlow
Copy link
Contributor

Hi @lsorber - Thanks for calling out the lack of clarity. I'll take a look at it and see what can be done to improve.

@luabud
Copy link
Member

luabud commented Jun 15, 2021

We will stop using "request" : "test" and will add a different argument for it instead (microsoft/vscode-python#15790). We will need to update the documentation to reflect that for sure, but it will be different from what we have now.

@JoshuaPartlow
Copy link
Contributor

Great, we'll track an update for the docs once those changes are made.

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

4 participants