prompt-toolkit / prompt-toolkit/python-prompt-toolkit
Documentation published is a bit lagging
Open
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 10.6k
- Forks
- 815
- PR merge metrics
- No merged PRs in 30d
Description
Noticed an issue in this documentation text and was going to PR, but it's already fixed 4 months ago.
It seems the files deployed in live docs are either cached with old version or lagging behind the current repo.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Compare the live Read the Docs page for the processing-inputrc section with the repository version and commit 031721fdbf135e6b77786f85a4c99675efac0308. Trace the documentation publishing or caching path to determine why the deployed page lags behind the repository; done means the live documentation reflects the fixed text.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100