Update readme based on most recent updates #368
Merged
Conversation
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
cwebster-99
requested review from
Copilot and
karthiknadig
and removed request for
Copilot
There was a problem hiding this comment.
Pull Request Overview
This PR updates the README to reflect recent changes in the extension's feature set and documentation. Key changes include:
- Revision of the extension title and description to remove "Package Manager" and improve clarity.
- Updates to the Features, Command Reference, Settings Reference, and API Reference sections with new content and formatting.
- Minor adjustments to image URL formatting and hyperlink styling.
Comments suppressed due to low confidence (1)
README.md:9
- There is a repeated phrase 'activated terminals Activate terminals'. Please remove the redundant text for clarity.
+- ✅ Create activated terminals Activate terminals
Comment on lines
+22
to
+28
| <img src=<https://raw.githubusercontent.com/microsoft/vscode-python-environments/main/images/python-envs-overview.gif> width=734 height=413> | ||
|
|
||
| ### Environment Management | ||
|
|
||
| This extension provides an Environments view, which can be accessed via the VS Code Activity Bar, where you can manage your Python environments. Here, you can create, delete, and switch between environments, as well as install and uninstall packages within the selected environment. It also provides APIs for extension developers to contribute their own environment managers. | ||
| The Python Environments panel provides an interface to create, delete and manage environments. | ||
|
|
||
| <img src=<https://raw.githubusercontent.com/microsoft/vscode-python-environments/main/images/environment-managers-quick-start.png> width=734 height=413> |
There was a problem hiding this comment.
The image source attribute uses nested angle brackets. Consider removing the extra angle brackets to ensure consistent Markdown/HTML rendering.
Copilot uses AI. Check for mistakes.
cwebster-99
commented
Apr 29, 2025
README.md
Outdated
| > Important: This extension currently requires the pre-release version of the Python extension (ms-python.python) to operate (version 2024.23.2025010901 or later). | ||
| > **Note:** This extension is in preview, and its APIs and features are subject to change as the project evolves. | ||
|
|
||
| > **Important:** This extension requires the pre-release version of the Python extension (`ms-python.python`) to operate (version 2024.23.2025010901 or later). |
There was a problem hiding this comment.
This was needed originally when we published the first version back in December. I think all we need to say now is that we need v2024.23 or greater.
|
|
||
| ## Features | ||
|
|
||
| <img src=https://raw.githubusercontent.com/microsoft/vscode-python-environments/main/images/python-envs-overview.gif width=734 height=413> | ||
| The "Python Projects" fold shows you all of the projects that are currently in your workspace and their selected environments. From this view you can add more files or folders as projects, select a new environment for your project, and manage your selected environments. |
There was a problem hiding this comment.
We should elaborate that a project in this case is anything that requires its own python environment.
There was a problem hiding this comment.
I go into detail about a project starting on line 59, is this ok?
cwebster-99
commented
Apr 29, 2025
cwebster-99
commented
Apr 29, 2025
roblourens
approved these changes
Apr 29, 2025
joyceerhl
approved these changes
Apr 29, 2025
eleanorjboyd
pushed a commit
to eleanorjboyd/vscode-python-environments
that referenced
this pull request
Apr 30, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
No description provided.