- Notifications
You must be signed in to change notification settings - Fork8
design doc addition#386
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 ourterms of service andprivacy statement. We’ll occasionally send you account related emails.
Already on GitHub?Sign in to your account
base:main
Are you sure you want to change the base?
Uh oh!
There was an error while loading.Please reload this page.
Conversation
@karthiknadig this is a first draft on a doc outlining technical design of the envs extension api. Would love a first pass of feedback, fixing any misunderstandings I have and what I might be missing / over-explaining. I am also not sure about the placement, do we just want it as part of the README or is it better as a separate file? |
Haven't had a chance to fully read and review but this is great! Since it is rather comprehensive, I would suggest keeping it as a separate file and linking from the README or storing this as a Wiki page that we can direct to in the README |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
Pull Request Overview
This PR adds a design documentation file outlining the Python Environments API for the VS Code extension.
- Introduces comprehensive technical design details on environment management, package handling, and project creation.
- Documents the interactions between various API components and the connection to the UI.
| ### Copilot Tooling | ||
| xxxx |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
The 'Copilot Tooling' section currently contains a placeholder ('xxxx'). Please update this section with a meaningful description or remove it until the appropriate content is available.
Copilot uses AI. Check for mistakes.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
The 'Copilot Tooling' section currently contains a placeholder ('xxxx'). Please update this section with a meaningful description or remove it until the appropriate content is available.
| @@ -0,0 +1,130 @@ | |||
| # Python Environments API | |||
| The following helps describe the technical design of the Python Environments Extension for use mainly by contributing extension authors. This extension is the entry point which will surface the entire environment management experience for Python in VS Code and its modularity should allow for individual tools / libraries to implement these methods for their tool making them usable in VS Code. | |||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
| The followinghelps describe the technical design of the Python Environments Extension foruse mainlyby contributing extension authors. This extension is the entry point which will surface the entire environment management experience for Python in VS Code and its modularity should allow for individual tools / libraries to implement these methods for their tool making them usable in VS Code. | |
| The followingguide describes the technical design of the Python Environments Extension. Its intendeduseismainlyfor contributing extension authors. This extension is the entry point which will surface the entire environment management experience for Python in VS Code and its modularity should allow for individual tools / libraries to implement these methods for their tool making them usable in VS Code. |
| ## Functionalities of Extension & its API | ||
| The python environment extension has four main functionalities: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
| Thepython environment extension has four main functionalities: | |
| ThePython Environments extension has four main functionalities: |
| ### Workspace and Environments | ||
| The relationship between **workspaces** and **environments** in the extension can be any of the following configurations: | ||
| | workspace | environment | description | example | |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
| |workspace|environment|description|example| | |
| |Workspace|Environment|Description|Example| |
No description provided.