-
Notifications
You must be signed in to change notification settings - Fork 3k
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
Move error message formatting recommendation into pip docs #12626
Comments
We should do this. Labelled appropriately to indicate that the next step here is to file a PR. |
Suggestion to the person who works on this: Edit the "User Interface Design" section of the UX guidance documentation, which lives at There are a few duplications and blank spots in the original text on Notion. Go ahead and copy them in as-is. A maintainer will figure out what text ought to go there and possibly edit the content a little as they review your pull request. |
Hey, I am new here. Can someone help me to solve this issue? |
@deveshpandee hi! What help do you need specifically? That is, what have you tried, and where are you stuck? |
Actually, I was having problem in understanding this issue. But, I have understood it now. I am opening a pr. Please review it. |
What's the problem this feature will solve?
Right now, the Preliminary error message formatting guidelines developed in 2020 (per this post) are hard for a developer to find - one has to know they exist by finding them via the PSF blog or a GitHub issue. Thus they are less useful as a ready resource for pip developers.
Describe the solution you'd like
Copy the text from Notion into https://pip.pypa.io/en/latest/ux-research-design/guidance/ .
Alternative Solutions
No, I haven't.
Additional context
We may want to also check out https://superbloomdesign.notion.site/Dependency-resolver-information-and-error-messages-proposal-f9108b43752a4414a94d3d47d8d519bb and other Notion, Dropbox, Google Docs, etc. resources created during that 2020 work and port them into the pip docs, or at least link centrally to them from there.
Code of Conduct
The text was updated successfully, but these errors were encountered: