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

Docs on import hook-based editable installs (PEP 660) #3440

Merged
merged 5 commits into from
Oct 7, 2022

Conversation

debonte
Copy link
Contributor

@debonte debonte commented Oct 7, 2022

Fixes #3407

Added details in TROUBLESHOOTING.md on why import hook-based editable installs cause problems for Pylance/Pyright and how to configure some common build backends to use .pth files instead.

@erictraut, should we replicate this info in https://github.com/microsoft/pyright/blob/main/docs/import-resolution.md? Or have a link between the docs in the two repos? Or?

Copy link
Contributor

@erictraut erictraut left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good. I added one minor suggestion.

I also like the idea of replicating this in the pyright documentation.

TROUBLESHOOTING.md Outdated Show resolved Hide resolved
@debonte debonte merged commit 640eaad into microsoft:main Oct 7, 2022
@debonte debonte deleted the issue3407 branch October 7, 2022 18:09
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

Successfully merging this pull request may close these issues.

User documentation on import hook-based editable installs (PEP 660)
3 participants