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

multi-line support for Completion.display_meta

Open
#1,285 4 comments 3 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

It will be highly useful when implementing REPL shows help text sorts.

image

Like here, we can show the docstring of the function. Is it possible to implement such ?

currently putting new lines look like this
image

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 at Completion.display_meta and trace how the REPL renders completion metadata. Check how embedded newlines are currently handled, then define the display behavior for multi-line help text and verify it against the examples in the issue.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
cli
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.