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

Synchronize stub file docstrings with original docstrings #37

Open
Armavica opened this issue Jan 4, 2025 · 0 comments
Open

Synchronize stub file docstrings with original docstrings #37

Armavica opened this issue Jan 4, 2025 · 0 comments

Comments

@Armavica
Copy link
Owner

Armavica commented Jan 4, 2025

While Jedi finds docstrings at runtime, Pylance extracts them statically, which does not work for docstrings provided in the Rust code. This is why we copied docstrings to the type stub file (#34), but they might come out of sync with the rust docstrings.
We could either wait that Pylance is able to find these docstrings, use a script to autogenerate the stub file with docstrings, or move the docstrings to the Python side of the bindings.

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

No branches or pull requests

1 participant