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

Generate stub files for Python bindings #7362

Closed
KingaJanicka opened this issue Dec 4, 2023 · 1 comment
Closed

Generate stub files for Python bindings #7362

KingaJanicka opened this issue Dec 4, 2023 · 1 comment
Labels
Feature Request New feature request

Comments

@KingaJanicka
Copy link
Contributor

Is your feature request related to a problem? Please describe!
The python build process does not generate stub files, meaning developers using VS Code don't get autocomplete or inline documentation.

Describe the solution you'd like:
Running pybind11-stubgen surgepy and moving the contents of stubs/surgepy to inside the site-packages surgepy directory results in quite nice inline documentation. This should be added to build process, PR forthcoming.
image

Describe alternatives you've considered:
Tried to generate using mypy stubgen but it didn't work.

@KingaJanicka KingaJanicka added the Feature Request New feature request label Dec 4, 2023
@baconpaul
Copy link
Collaborator

Oh cool! Please add yourself to AUTHORS when you pr since this will be your first pr.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Feature Request New feature request
Projects
None yet
Development

No branches or pull requests

2 participants