prompt-toolkit / prompt-toolkit/python-prompt-toolkit
Explain layout better
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 10.6k
- Forks
- 815
- PR merge metrics
- No merged PRs in 30d
Description
Is it possible to color references to different layout component classes on this page:
http://python-prompt-toolkit.readthedocs.io/en/stable/pages/full_screen_apps.html#the-layout
It seems that there are three groups of layout components:
Container,HSplit,VSplit,FloatContainer- (light-blue lines) specify layout only (no flow direction)Window- (red) flow and scrollingUIControl,BufferControl,FormattedTextControl- (green) object that is being placed intoWindow
Then all three levels can be grouped into single widget - TextArea, Button, Frame (what's the difference with Window/Container), VerticalLine. Would be nice to see decomposition of VerticalLine into basic layout components.
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
Start with the linked full-screen applications documentation page and locate the source for its “The layout” section. Update the explanation to distinguish the three component groups, clarify the relationship between widgets and layout components, and show the decomposition of VerticalLine; the page should render with the requested color coding and examples.
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
- 35/100