prompt-toolkit / prompt-toolkit/python-prompt-toolkit

Documentation update about some PEPs' statuses

Open
#896 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
10.6k
Forks
815
PR merge metrics
No merged PRs in 30d

Description

I'm checking out prompt-toolkit for the first time and reading through the documentation. I noticed this part mentions some PEPs which were presumably proposed at the time of writing, but now it looks like PEP 567 is accepted and the others were withdrawn. I don't really know anything about this to fix myself but I thought I'd point it out! @jonathanslenders looks like you wrote this part :)

https://github.com/prompt-toolkit/python-prompt-toolkit/blob/a66d60247a53849a016ee4660511998eb99934ca/docs/pages/upgrading.rst#L64-L72

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

Open docs/pages/upgrading.rst and inspect the PEP references in the linked lines 64-72. Verify the current status of each referenced PEP, update the documentation to reflect those statuses, and consider the work done when the section is factually current.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
52/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.