Skip to content

Move error message formatting recommendation into pip docs #12626

Open
@brainwane

Description

@brainwane

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

Metadata

Metadata

Assignees

No one assigned

    Labels

    good first issueA good item for first time contributors to work onstate: awaiting PRFeature discussed, PR is neededtype: docsDocumentation related

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions