Skip to content

Commit 2476587

Browse files
cwebster-99ntrogh
andauthored
Apply suggestions from code review
Co-authored-by: Nick Trogh <1908215+ntrogh@users.noreply.github.com>
1 parent 51d0bea commit 2476587

File tree

1 file changed

+15
-15
lines changed

1 file changed

+15
-15
lines changed

docs/python/python-quick-start.md

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -11,42 +11,42 @@ MetaSocialImage: images/tutorial/social.png
1111

1212
# Quick Start Guide for Python in VS Code
1313

14-
The Python extension makes VS Code an excellent Python editor, works on any operating system, and is usable with a variety of Python interpreters.
14+
The Python extension makes Visual Studio Code an excellent Python editor, works on any operating system, and is usable with a variety of Python interpreters.
1515

1616
Get started by installing:
1717
- [VS Code](https://code.visualstudio.com/)
18-
- [A Python Interpreter](https://code.visualstudio.com/docs/python/python-tutorial#_install-a-python-interpreter) (any [actively supported Python version](https://devguide.python.org/#status-of-python-branches))
18+
- [A Python Interpreter](/docs/python/python-tutorial.md#_install-a-python-interpreter) (any [actively supported Python version](https://devguide.python.org/#status-of-python-branches))
1919
- [Python extension](https://marketplace.visualstudio.com/items?itemName=ms-python.python) from the VS Code Marketplace
2020

2121
![Gif installing the Python extension in a fresh install of VS Code](/docs/python/images/quick-start/qs-python-ext-install.gif)
2222

23-
To further customize VS Code for Python, you can leverage the [Python profile template](https://code.visualstudio.com/docs/editor/profiles#_python-profile-template), automatically installing recommended extensions and settings. For Data Science projects, consider using the [Data Science profile template](https://code.visualstudio.com/docs/editor/profiles#_data-science-profile-template).
23+
To further customize VS Code for Python, you can leverage the [Python profile template](/docs/editor/profiles.md#python-profile-template), automatically installing recommended extensions and settings. For Data Science projects, consider using the [Data Science profile template](/docs/editor/profiles.md#data-science-profile-template).
2424

2525
![Gif showing the Python profile template being installing into VS Code.](/docs/python/images/quick-start/python-profile-create.gif)
2626

2727
## How to create and open a Python project or file
2828

29-
If you have an existing Python project you wish to work on in VS Code, you can begin by opening your folder or file from the VS Code welcome page or Explorer panel, or by selecting **File > Open Folder** (`kb(workbench.action.files.openFolder)`) or **File > Open File** (`kb(workbench.action.files.openFile)`).
29+
If you have an existing Python project you wish to work on in VS Code, you can begin by opening your folder or file from the VS Code Welcome page or File Explorer view, or by selecting **File > Open Folder** (`kb(workbench.action.files.openFolder)`) or **File > Open File** (`kb(workbench.action.files.openFile)`).
3030

31-
You can create a new Python files by selecting **New File** in the VS Code Welcome page and select **Python file**, or navigating to **File > New File** (`kb(workbench.action.files.newFile)`).
31+
You can create a new Python file by selecting **New File** on the VS Code Welcome page and then selecting **Python file**, or by navigating to **File > New File** (`kb(workbench.action.files.newFile)`).
3232

33-
> **Tip:** If you already have a workspace folder open in VS Code, you can add new files or folders directly into your existing project. You can create new folders and file by clicking the icons on the top level folder in the Explorer panel.
33+
> **Tip:** If you already have a workspace folder open in VS Code, you can add new files or folders directly into your existing project. You can create new folders and files by using the corresponding **New Folder** or **New File** icons on the top level folder in the File Explorer view.
3434
3535
## UI Tour
3636

37-
When you launch VS Code for the very first time, you will need to install the Python extension to get Python specific features and UI. Let’s look at the UI once the Python extension is installed.
37+
When you launch VS Code for the very first time, you will need to install the Python extension to get Python-specific features and UI. Let’s look at the UI after installing the Python extension:
3838

3939
![Image of the Python UI highlights in VS Code.](/docs/python/images/quick-start/ui-tour.png)
4040

4141
## Code Actions
4242

43-
Code Actions (also known as Quick Fixes) are provided when there are Warnings or Errors to help fix issues you may be experiencing in your code. These helpful hints are displayed in the editor left margin as a lightbulb (💡). Click on the light bulb to display Code Action options which can come from extensions such as Python, Pylance, or VS Code itself. For more information about Code Actions, see [Python Quick Fixes](https://code.visualstudio.com/docs/python/editing#_quick-fixes).
43+
Code Actions (also known as Quick Fixes) are provided to help fix issues when there are warnings in your code. These helpful hints are displayed in the editor left margin as a lightbulb (💡). Select the light bulb to display Code Action options. These Code Action can come from extensions such as Python, Pylance, or VS Code itself. For more information about Code Actions, see [Python Quick Fixes](/docs/python/editing.md#quick-fixes).
4444

4545
![Gif showing Code Actions in a Python project.](images/editing/quickFix.gif)
4646

47-
## Python Commands
47+
## Python commands
4848

49-
Python commands can be accessed through the [Command Palette](https://code.visualstudio.com/docs/getstarted/userinterface#_command-palette) (`kb(workbench.action.showCommands)`). From the Command Palette, you have access to various features from VS Code as well as installed extensions. Begin typing **“Python: “** to locate the commands accessible through the Python extension.
49+
Python commands can be accessed through the [Command Palette](/docs/getstarted/userinterface.md#_command-palette) (`kb(workbench.action.showCommands)`). From the Command Palette, you have access to various features from VS Code and installed extensions. Enter **“Python: “** in the Command Palette to find the commands available through the Python extension.
5050

5151
![Gif demonstrating how to access Python commands in the Command Palette.](/docs/python/images/quick-start/cmd-plt-v2.gif)
5252

@@ -58,7 +58,7 @@ Now that you are more familiar with Python in VS Code, let’s learn how to run,
5858

5959
There are a few ways to run Python code in VS Code.
6060

61-
To run the Python script you have open on the editor, click the **Run Python File in Terminal** play button in the top-right of the editor.
61+
To run the Python script you have open on the editor, select the **Run Python File in Terminal** play button in the top-right of the editor.
6262

6363
![Image showing the Run Python File in Terminal play button.](images/tutorial/run-python-file-in-terminal-button.png)
6464

@@ -72,24 +72,24 @@ The debugger is a helpful tool that allows you to inspect the flow of your code
7272

7373
![Screenshot showing a debugger breakpoint in a Python program.](/docs/python/images/quick-start/breakpoint.png)
7474

75-
To start debugging, initialize the debugger by pressing `F5`. Since this is your first time debugging this file, a configuration menu will open allowing you to select the type of application you want to debug. If it's a Python script, you can select "Python File".
75+
To start debugging, initialize the debugger by pressing `kbstyle(F5)`. Since this is your first time debugging this file, a configuration menu will open allowing you to select the type of application you want to debug. If it's a Python script, you can select **Python File**.
7676

7777
Once your program reaches the breakpoint, it will stop and allow you to track data in the Python Debug console, and progress through your program using the debug toolbar.
7878

7979
![Gif showing how to configure the Python debugger for the first time.](images/quick-start/qs-debug-v2.gif)
8080

81-
For a deeper dive into Python debugging functionality, see [Python debugging in VS Code](https://code.visualstudio.com/docs/python/debugging).
81+
For a deeper dive into Python debugging functionality, see [Python debugging in VS Code](/docs/python/debugging.md).
8282

8383
### Test
8484
The Python extension provides robust testing support for [Unittest](https://docs.python.org/3.3/library/unittest.html) and [pytest](https://pytest.org/en/7.4.x/).
8585

86-
You can configure Python tests through the Test Panel on the Activity Bar by selecting **Configure Python Tests** and selecting your test framework of choice.
86+
You can configure Python tests through the Testing view on the Activity Bar by selecting **Configure Python Tests** and selecting your test framework of choice.
8787

8888
You can also create tests for your Python project, which the Python extension will attempt to discover once your framework of choice is configured. The Python extension also allows you to run and debug your tests in the Testing view and inspect the test run output in the Test Results panel.
8989

9090
![Gif demonstrating test configuration, discovery, and run in the Python extension.](/docs/python/images/quick-start/qs-testing.gif)
9191

92-
For a comprehensive look at testing functionality, see [Python testing in VS Code](https://code.visualstudio.com/docs/python/testing).
92+
For a comprehensive look at testing functionality, see [Python testing in VS Code](/docs/python/testing.md).
9393

9494
## Next steps
9595

0 commit comments

Comments
 (0)