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

Reword and migrate editable errors to rich format #12464

Closed
wants to merge 3 commits into from

Conversation

ichard26
Copy link
Member

@ichard26 ichard26 commented Jan 7, 2024

Before:
image

After:
image
Towards #10421. ✨

@ichard26
Copy link
Member Author

ichard26 commented Jan 7, 2024

A general question I have is whether to let rich automatically highlight numbers, links, paths, etc. It's distracting noise for most requirements, but it could be nicer for URLs.

@pradyunsg
Copy link
Member

A general question I have is whether to let rich automatically highlight numbers, links, paths, etc. It's distracting noise for most requirements, but it could be nicer for URLs.

For now, wrapping these in Text is reasonable -- I have a personal TODO somewhere to change the highlighter we're using in pip's rich renders to highlight specific things nicely.

@ichard26 ichard26 marked this pull request as draft January 8, 2024 01:23
@ichard26
Copy link
Member Author

ichard26 commented Jan 8, 2024

Actually this needs some work because (invalid) editable requirements can be created as part of userflows that don't involve installation, like pip wheel -e . (which is silly but is supported), hmm.

The error can raised by pip wheel (yea, I know) so it's best to avoid
mentioning installation.
@ichard26
Copy link
Member Author

The invalid editable error may still be confusing in the context of pip wheel, but I'm not sure how to address that without improving the error in the significantly more important case of pip install. I suppose I could tweak the error message based on what command is running, but that seems like too much engineering for an uncommon situation.

@ichard26 ichard26 marked this pull request as ready for review January 27, 2024 01:03
@ichard26 ichard26 marked this pull request as draft March 11, 2024 03:59
@pradyunsg
Copy link
Member

@ichard26 Why is this PR marked as a draft?

@ichard26
Copy link
Member Author

See #12811 which has the conflicts fixed + some further improvements!

@ichard26 ichard26 closed this Jun 28, 2024
@ichard26 ichard26 deleted the errors/editable-mode branch July 10, 2024 23:04
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Jul 28, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants