Skip to content
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

Document Jupyter related types in @vscode/python-extension npm package #13982

Closed
karrtikr opened this issue Jul 25, 2023 · 3 comments
Closed
Assignees
Labels
feature-request Request for new features or functionality

Comments

@karrtikr
Copy link
Contributor

karrtikr commented Jul 25, 2023

We now have a npm package which carries the Python extension api types.

See microsoft/vscode-python#21690 (comment). If you would like these types to be present in the @vscode/python-extension API, these should likely be documented. Otherwise let us know and we'll remove these types from the package.

Types for package are defined here: https://github.com/microsoft/vscode-python/blob/main/src/client/api/types.ts

@DonJayamanne
Copy link
Contributor

If you would like these types to be present in the @vscode/python-extension API, these should

I don't think there's a need to expose this api in the public npm as they are useful only to thr Jupyter extension.

In a way it's private for Jupyter extension, and cannot be used by any other extension, if called by others then it's a noop. As the result of calling that API is that python extension will call back into Jupyter extension

@karrtikr
Copy link
Contributor Author

Actually there're other types as well: https://github.com/microsoft/vscode-python/blob/8b9bca1fd5a684d454e0d97583642cb46553241e/src/client/api/types.ts#L128-L167, which seem to be Jupyter specific, which I think you would like to include in the package. I think these are specific for dataviewer: https://github.com/microsoft/vscode-python/blob/8b9bca1fd5a684d454e0d97583642cb46553241e/src/client/api/types.ts#L38-L49

@karrtikr karrtikr reopened this Jul 25, 2023
@DonJayamanne
Copy link
Contributor

DonJayamanne commented Jul 25, 2023

No, we don't need those either.
I do not think we should publish anything that very specific & private for Jupyter extenssion.
Please feel free to remove them from the npm package

In a way it's private for Jupyter extension, and cannot be used by any other extension, if called by others then it's a noop. As the result of calling that API is that python extension will call back into Jupyter extension

Its pointless, tomorrow if we remove them , then its not a breaking change in the API.
I.e. we should only document stuff in the API thats publish and shoudl never be removed.

However private items such as those used by Jupyter can be removed as its technically not public (not a public API)

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Sep 9, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
feature-request Request for new features or functionality
Projects
None yet
Development

No branches or pull requests

3 participants