Commit Graph

16 Commits

Author SHA1 Message Date
Dave Pearson
718760dcb1 Fix some assorted documentation cross-references
Couple or so things I noticed while working on docs.
2023-05-24 15:53:56 +01:00
Will McGugan
faa67a8293 Screen docs (#2579)
* screen docs

* docstrings

* modal example

* docstring

* docstrings

* Apply suggestions from code review

Co-authored-by: Dave Pearson <davep@davep.org>

---------

Co-authored-by: Dave Pearson <davep@davep.org>
2023-05-16 13:44:06 +01:00
Will McGugan
0940546aab compositor refactor and transparent screens (#2139)
* compositor refactor and trasparent screens

* multuple layers

* catch screen stack error

* refinement

* error messages

* capture screen stack

* new border type

* Background screen

* borders and bindings

* snapshot

* screen docs

* fix for missing screens

* screens docs

* fix for non updating transparent screens

* fix background resize

* changelog

* copy

* superfluous function

* update diagram

* inline code

* Update CHANGELOG.md

Co-authored-by: Rodrigo Girão Serrão <5621605+rodrigogiraoserrao@users.noreply.github.com>

* Update docs/guide/screens.md

Co-authored-by: Rodrigo Girão Serrão <5621605+rodrigogiraoserrao@users.noreply.github.com>

* Apply suggestions from code review

Co-authored-by: Rodrigo Girão Serrão <5621605+rodrigogiraoserrao@users.noreply.github.com>

* superfluous file

* Explicit None

* Apply suggestions from code review

Co-authored-by: Rodrigo Girão Serrão <5621605+rodrigogiraoserrao@users.noreply.github.com>

* docstring

* update docstring

* docstring make property private

* Apply suggestions from code review

Co-authored-by: Rodrigo Girão Serrão <5621605+rodrigogiraoserrao@users.noreply.github.com>

* docstring

* update docstring

* Apply suggestions from code review

Co-authored-by: Rodrigo Girão Serrão <5621605+rodrigogiraoserrao@users.noreply.github.com>

* docstrings

* remove comment, add docstring

* Apply suggestions from code review

Co-authored-by: Dave Pearson <davep@davep.org>

---------

Co-authored-by: Rodrigo Girão Serrão <5621605+rodrigogiraoserrao@users.noreply.github.com>
Co-authored-by: Dave Pearson <davep@davep.org>
2023-03-27 16:44:58 +01:00
Dave Pearson
e6f620db44 Remove underscore pauses from (hopefully) all snapshots
This seeks to remove the "_" from the key presses of snapshots and inline
runs in the documentation. The "_" no longer does anything, but got legacy
reasons at the moment we can't actually allow "_" to be an input to a
"faked" keypress in the docs and snapshots.

Removing these clears the way to letting "_" have the same status as any
other character.

See #1994.
2023-03-09 20:32:27 +00:00
Dave Pearson
a20dbbe325 Drop the
This could either be dropping `the`, as I've done here, or perhaps adding
something like `approach` after `SCREENS`. I feel one or the other is needed
to make this flow well.
2022-10-15 22:26:19 +01:00
Dave Pearson
bdbdb62fd0 Code markup Screen 2022-10-15 22:25:16 +01:00
Dave Pearson
f14f09d80a Add 'a' and code-markup dict 2022-10-15 22:24:36 +01:00
Dave Pearson
5f97884798 associated -> associate 2022-10-15 22:21:18 +01:00
Dave Pearson
c856ab3e38 screen -> key 2022-10-15 22:20:24 +01:00
Dave Pearson
7360e226c1 Correct the highlighted lines
I'd not realised that
78ea2cd9f8
would have a visible knock-on effect in the docs, because the docs specify
which lines should be highlighted. As per this comment
https://github.com/Textualize/textual/pull/888#issuecomment-1277298383 this
corrects that.
2022-10-13 11:03:53 +01:00
Dave Pearson
f127506e60 Remove some trailing whitespace 2022-10-13 11:03:17 +01:00
Will McGugan
d93b9c7a66 wording 2022-10-05 10:54:52 +01:00
Will McGugan
f6e3cc6517 screens api 2022-10-04 17:48:25 +01:00
Will McGugan
d9d5791925 todos 2022-09-06 15:39:41 +01:00
Will McGugan
3e41e14714 box diagram 2022-09-06 10:50:12 +01:00
Will McGugan
e7d57a4aa2 renamed introduction to tutorial 2022-09-05 21:30:29 +01:00