Skip to content

Improving getting started instructions in README and minor updates to contributors guide #605

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

Merged
merged 4 commits into from
Jan 29, 2018

Conversation

qubitron
Copy link

This PR is to make the extension README easier for new users to learn how to get set-up developing with Python in VS Code.

This fixes #551, and fixes #589.

@chetsangnil

@codecov
Copy link

codecov bot commented Jan 20, 2018

Codecov Report

Merging #605 into master will increase coverage by 1.26%.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff             @@
##           master     #605      +/-   ##
==========================================
+ Coverage   58.06%   59.33%   +1.26%     
==========================================
  Files         225      239      +14     
  Lines       10152    12068    +1916     
  Branches     1751     2297     +546     
==========================================
+ Hits         5895     7160    +1265     
- Misses       4252     4900     +648     
- Partials        5        8       +3
Impacted Files Coverage Δ
...lient/interpreter/locators/services/condaHelper.ts 57.77% <0%> (-10.65%) ⬇️
src/client/common/installer/installer.ts 56.49% <0%> (-7.58%) ⬇️
src/client/common/extensions.ts 93.33% <0%> (-6.67%) ⬇️
src/client/common/configuration/service.ts 94.11% <0%> (-5.89%) ⬇️
src/client/common/application/workspace.ts 14.28% <0%> (-3.37%) ⬇️
src/client/linters/pylint.ts 98.11% <0%> (-1.89%) ⬇️
src/client/common/installer/condaInstaller.ts 69.33% <0%> (-1.58%) ⬇️
src/client/common/terminal/helper.ts 97.1% <0%> (-0.46%) ⬇️
src/client/providers/completionProvider.ts 100% <0%> (ø) ⬆️
src/client/common/installer/serviceRegistry.ts 100% <0%> (ø) ⬆️
... and 63 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update ba069d2...86ace61. Read the comment docs.

README.md Outdated
```Python: Select Interpreter``` | Switch between Python interpreters, versions, and environments.
```Python: Start REPL``` | Start an interactive Python REPL using the selected interpreter in the VS Code terminal.
```Python: Run Python File in Terminal``` | Runs the active Python file in the VS Code terminal. You can also run a Python file by right-clicking on the file and selecting ```Run Python File in Terminal```.
```Python: Select Linter``` | Switch from PyLint to flake8 or other supported linters.

To see all available Python commands, open the Command Palette and type ```Python```.

Choose a reason for hiding this comment

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

This is great! Love it when we tell users how to access important functionality and not assuming that they would already know how to do.

Copy link

@kraigb kraigb left a comment

Choose a reason for hiding this comment

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

Looks good to me.

@qubitron qubitron merged commit 2aded04 into microsoft:master Jan 29, 2018
@lock lock bot locked as resolved and limited conversation to collaborators Jul 31, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Documentation has wrong name for "Select Interpreter" command Improve Getting Started for README
4 participants