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

Documentation doesn't reflect new input hook logic introduced since 3.0.40

Open
#1,879 0 comments 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

This does no longer work, the hook must now be passed as an argument to Application.run():

https://github.com/prompt-toolkit/python-prompt-toolkit/blob/6a58564f6a201f1234733f726d866a64e95b6ba3/docs/pages/advanced_topics/input_hooks.rst?plain=1#L38

Also, none of the CHANGELOG entries mention the breaking API changes (cf. #1809 for some of the fallout).

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 with docs/pages/advanced_topics/input_hooks.rst at the referenced example and verify the current Application.run() hook argument behavior. Review issue #1809 and the CHANGELOG to identify the breaking API changes that are missing. Done means the input-hook documentation and relevant changelog entries reflect the current behavior.

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.