pypa / pypa/packaging.python.org

Add PEP compliant Documentation if JSON API PEP Accepted

Open
#765 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
1.7k
Forks
1.7k
Avg merge
3d 12h
Merged PRs (30d)
4

Description

Proposing some slight modifications to the JSON API to allow custom indexes to implement. e.g. devpi

Issue here: https://github.com/pypa/packaging-problems/issues/367

This is a reminder to update the spec here if accepted: https://github.com/pypa/packaging.python.org/tree/master/source/specifications

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

First review packaging-problems issue 367 to determine whether the proposed JSON API changes were accepted. Then inspect the source/specifications documentation path and update the relevant specification only if the PEP is accepted; done means the documentation reflects the accepted API changes.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.