pypa / pypa/distutils

Possible inaccuracy in extension typespec

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

Nobody has claimed this yet.

Dominant language
Python
Stars
59
Forks
94
PR merge metrics
No merged PRs in 30d

Description

I just realized a possible inaccuracy: This documents instance attributes, not parameters. In which case the old docstring was (almost) correct. (sources is still a list[str], not a list[string | os.PathLike] because of os.fspath)

Originally posted by @Avasam in https://github.com/pypa/distutils/pull/311#discussion_r1903354895

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

Start by locating the extension typespec and its associated docstring, then compare whether each annotation describes instance attributes or parameters. Verify the issue's claim that sources is list[str] rather than list[string | os.PathLike], and consider the work complete when the documentation and typespec accurately describe the intended values.

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
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.