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

{Docs} Documentation update for debugging this repository using VS Code #14559

Merged
merged 20 commits into from
Oct 14, 2020

Conversation

niswitze
Copy link
Contributor

Description
Updates for setting up a development environment to debug this project in VS Code. Removing the section on using the property python.pythonPath in settings.json as this property has become deprecated in the current Python extension for VS Code.

This checklist is used to make sure that common guidelines for a pull request are followed.

@yonzhan
Copy link
Collaborator

yonzhan commented Jul 29, 2020

Docs

@fengzhou-msft
Copy link
Member

@niswitze should we also update launch.json, change to "pythonPath": "${command:python.interpreterPath}"?

"pythonPath": "${config:python.pythonPath}",

Nicholas Switzer added 3 commits August 11, 2020 20:26
…de. Updating the section around selecting a python environment to detail the option for setting pythonPath using either settings.json or launch.json.
@niswitze
Copy link
Contributor Author

@niswitze should we also update launch.json, change to "pythonPath": "${command:python.interpreterPath}"?

"pythonPath": "${config:python.pythonPath}",

I would say let's leave that up to the user. They have a few options for setting this value and we should probably leave it to whichever method they prefer.

@jiasli
Copy link
Member

jiasli commented Aug 25, 2020

@niswitze should we also update launch.json, change to "pythonPath": "${command:python.interpreterPath}"?

"pythonPath": "${config:python.pythonPath}",

${config:python.pythonPath} should now be ${command:python.interpreterPath}. There is an error in VSCode Python's doc (microsoft/vscode-python#13380).

@jiasli
Copy link
Member

jiasli commented Oct 13, 2020

Perhaps we should put this on hold, given that the doc from VSCode Python is still self-conflicting (microsoft/vscode-python#13380).

https://code.visualstudio.com/docs/python/environments#_choose-a-debugging-environment

python.pythonPath setting in the workspace settings.json

https://code.visualstudio.com/docs/python/debugging#_python

python: Full path that points to the Python interpreter to be used for debugging.

Comment on lines -49 to -53
```
{
"python.pythonPath": "C:\\repo\\env\\Scripts\\python.exe"
}
```
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Perhaps we can add the example back?

@fengzhou-msft fengzhou-msft merged commit 51e3db9 into Azure:dev Oct 14, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants