pip icon indicating copy to clipboard operation
pip copied to clipboard

Move error message formatting recommendation into pip docs

Open brainwane opened this issue 10 months ago • 5 comments

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

brainwane avatar Apr 16 '24 00:04 brainwane

We should do this. Labelled appropriately to indicate that the next step here is to file a PR.

pradyunsg avatar Apr 16 '24 14:04 pradyunsg

Suggestion to the person who works on this:

Edit the "User Interface Design" section of the UX guidance documentation, which lives at docs/html/ux-research-design/guidance.md (viewable here). I suggest you create a new section, immediately before "Design Principles / Usability Heuristics".

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.

brainwane avatar Apr 17 '24 18:04 brainwane

Hey, I am new here. Can someone help me to solve this issue?

deveshpandee avatar Apr 19 '24 18:04 deveshpandee

@deveshpandee hi! What help do you need specifically? That is, what have you tried, and where are you stuck?

brainwane avatar Apr 19 '24 18:04 brainwane

Actually, I was having problem in understanding this issue. But, I have understood it now. I am opening a pr. Please review it.

deveshpandee avatar Apr 20 '24 20:04 deveshpandee