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

Multiline prompts?

Open
#1,377 5 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

I am trying to use a Completion where the display_meta is very long (like help text). But I can't get it to wrap / render new lines (\r nor \n).
newlines render as ^J. I also tried using <br/> when parsing as HTML but that also doesn't work.
is this supported/ easy to support?

Example image attached
Screenshot_20210220_160414

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 tracing how Completion.display_meta is rendered in the command-line interface and reproduce the reported behavior with the linked screenshot's multiline help-text example. Done means multiline display_meta content renders with wrapping or newlines instead of literal ^J, with the supported behavior covered by an appropriate test.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.