python / python/typing

Suggest how stub packages can be tied to the appropriate version of their parent package

Open
#1,264 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

topic: documentation
Dominant language
Python
Stars
1.8k
Forks
302
Avg merge
23h
Merged PRs (30d)
8

Description

Over at https://discuss.python.org/t/allow-package-references-as-version-specifiers/19226/ someone asked for a packaging feature to help keep type stub packages set to the same version as their parent package. https://discuss.python.org/t/allow-package-references-as-version-specifiers/19226/17 has a suggestion on how to do that.

Having such info on https://typing.readthedocs.io/en/latest/source/stubs.html#distribution may be helpful.

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

Read the proposed approach in the linked Python discussion, especially post 17, then review the Distribution section of https://typing.readthedocs.io/en/latest/source/stubs.html. Update that documentation with guidance on tying stub packages to the appropriate parent-package version, and verify that the explanation accurately reflects the proposal.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
38/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.