docs: clarify Python setup components and shell restart for beginners#9800
Open
Dotify71 wants to merge 1 commit into
Open
docs: clarify Python setup components and shell restart for beginners#9800Dotify71 wants to merge 1 commit into
Dotify71 wants to merge 1 commit into
Conversation
Closes microsoft#9790. - Add 'Understanding the Python development stack' section to python-tutorial.md explaining the distinction between VS Code (editor), the Python extension (helper), and the Python interpreter (runner) using a simple kitchen analogy. - Add a NOTE block demystifying the 'shell' and 'restart' terminology, explaining what a terminal is and why restarting it is necessary after installing Python for the first time. - Add a TIP block to python-quick-start.md summarizing all three components and the restart requirement at the top of the quick start guide.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Closes #9790.
During usability testing, new users were confused about:
This PR addresses both pain points in the beginner Python getting started documentation.
Changes
docs/python/python-tutorial.md[!NOTE]block under the interpreter installation verification step that demystifies "shell" and "terminal" terminology and explains why restarting it is required after a fresh Python installation.docs/python/python-quick-start.md[!TIP]block near the top summarising all three components (editor, extension, interpreter) and the restart requirement, giving quick-start users the same conceptual grounding.Testing
All changes are pure markdown. Formatting follows existing VS Code docs conventions.