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.

Sign up for GitHub

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

Jump to bottom

Move error message formatting recommendation into pip docs #12626

Open
1 task done
brainwane opened this issue Apr 16, 2024 · 5 comments · May be fixed by #12642
Open
1 task done

Move error message formatting recommendation into pip docs #12626

brainwane opened this issue Apr 16, 2024 · 5 comments · May be fixed by #12642
Labels
good first issue A good item for first time contributors to work on state: awaiting PR Feature discussed, PR is needed type: docs Documentation related

Comments

@brainwane
Copy link
Contributor

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 brainwane added type: feature request Request for a new feature S: needs triage Issues/PRs that need to be triaged labels Apr 16, 2024
@pradyunsg pradyunsg added type: docs Documentation related state: awaiting PR Feature discussed, PR is needed and removed type: feature request Request for a new feature S: needs triage Issues/PRs that need to be triaged labels Apr 16, 2024
@pradyunsg
Copy link
Member

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

@brainwane brainwane added the good first issue A good item for first time contributors to work on label Apr 17, 2024
@brainwane
Copy link
Contributor Author

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.

@deveshpandee
Copy link

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

@brainwane
Copy link
Contributor Author

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

@deveshpandee
Copy link

deveshpandee commented Apr 20, 2024 •
edited

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

@deveshpandee deveshpandee linked a pull request Apr 20, 2024 that will close this issue
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
good first issue A good item for first time contributors to work on state: awaiting PR Feature discussed, PR is needed type: docs Documentation related
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

[fix]: Move error message formatting recommendation into pip docs #12626 deveshpandee/pip
3 participants
@brainwane @pradyunsg @deveshpandee