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

Documentation error at ReadTheDocs

Open
#774 3 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

https://python-prompt-toolkit.readthedocs.io/en/stable/pages/printing_text.html#printing-text
shows this code

`from prompt_toolkit.styles import Style

style = Style.from_dict({
'pygments.keyword': 'underline',
'pygments.literal.string': 'bg:#00ff00 #ffffff',
})
print_formatted_text(PygmentsTokens(tokens), style=style)`

However, tokens is not defined, resulting in "NameError: name 'tokens' is not defined"

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 the linked ReadTheDocs printing-text page and locate the example using PygmentsTokens and print_formatted_text. Replace the undefined tokens reference with a complete valid example, then verify that the documented snippet can run without a NameError.

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.