Skip to content

Add error message formatting section to UX guidance #13456

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

Closed
wants to merge 3 commits into from

Conversation

ishan372or
Copy link

This PR adds a section to the UX guidance documentation covering error message formatting principles and examples.

 1.Based on the 2020 UX error message proposal

 2.Includes structured examples for dependency conflict errors

 3.Aims to improve clarity and usability of pip error messages

@notatallshaw
Copy link
Member

Hi and thanks for the time you spent on making this PR.

However, I believe the UX guidance in the pip documentation has a specific history and lineage that was contracted and involved user studies. Other maintainers may want to comment but I don't think we will be looking to modify or add to it without a very strong justification.

Further, unrelated changes should not be part of a PR, e.g. the update to .gitignore and exceptions.py.

@ishan372or
Copy link
Author

Thank you for the feedback. That makes sense — I wasn't aware the UX guidance was based on contracted research. I’ll close this PR and look for more appropriate issues to contribute to. Appreciate your time!

@ishan372or ishan372or closed this Jul 1, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants