Commit graph

516 commits

Author SHA1 Message Date
Darren Burns
2c28b31ce7
Merge branch 'docs-updates-11sep24' of github.com:Textualize/textual into docs-updates-11sep24 2024-09-30 15:56:33 +01:00
Darren Burns
cd3e238716
Wording 2024-09-30 15:56:25 +01:00
Darren Burns
8b99b3fae4
PR feedback 2024-09-30 15:48:19 +01:00
Darren Burns
e12bbd6e86
Update docs/guide/widgets.md
Co-authored-by: Will McGugan <willmcgugan@gmail.com>
2024-09-30 15:32:44 +01:00
Darren Burns
f03f0386fa
Fix link to focus docs 2024-09-30 10:23:10 +01:00
Darren Burns
aa13ab4a34
Fix a typo 2024-09-30 10:21:36 +01:00
Darren Burns
5dbb5ff2b2 Remove newline 2024-09-25 15:46:36 +01:00
Darren Burns
c6a0aba38a Fix formatting 2024-09-25 15:08:14 +01:00
Darren Burns
ed5864dfe9 Add notes to code 2024-09-25 12:45:34 +01:00
Darren Burns
6382685502 Simplify and use RenderResult over str 2024-09-25 12:31:46 +01:00
Darren Burns
3c8f5672f4 Bindings and focus example Counter 2024-09-25 12:17:09 +01:00
Darren Burns
86a6fcc18d Counter example 2024-09-25 11:42:14 +01:00
Darren Burns
176cd5ebf5 More docs 2024-09-24 14:56:28 +01:00
Darren Burns
0fb0e2b7f7 Simplify wording, add counter example 2024-09-24 14:08:08 +01:00
Wouter de Vries
35fa7bfe86
Fix --help flag in docs 2024-09-21 21:56:06 +02:00
Will McGugan
6043845e8d
Merge pull request #5000 from Textualize/ansi-color
allow ansi color
2024-09-17 13:05:55 +01:00
Will McGugan
de11e122ec docs 2024-09-17 12:43:45 +01:00
friscorose
0dd3b946c8
Update styles.md
simple link change
2024-09-15 10:00:56 -04:00
Darren Burns
3e1b4131f0 typo 2024-09-12 13:37:08 +01:00
Darren Burns
6f6c987f12 Docs example 2024-09-12 13:35:33 +01:00
Darren Burns
fde23733fc
Mention can_focus in docs, note on how bindings are checked 2024-09-11 14:01:40 +01:00
Darren Burns
295f95b430
Add section on "focusable widgets" to "Input" page of guide 2024-09-11 13:18:42 +01:00
TomJGooding
e54db0e16b
docs(testing): clarify testing frameworks section (#4898)
* docs(testing): clarify testing frameworks section

* explain the auto asyncio mode
2024-09-11 12:58:58 +01:00
Will McGugan
94cde8a8dc promote serve up a level 2024-08-30 18:57:38 +01:00
Will McGugan
66132b8c42 docs 2024-08-30 18:49:33 +01:00
Will McGugan
011ac1df59 Faster query_one 2024-08-28 14:45:24 +01:00
TomJGooding
3316eb7555 it's -> its 2024-08-27 15:39:16 +01:00
TomJGooding
9a43e50472 behaviour -> behavior 2024-08-27 15:15:04 +01:00
Will McGugan
da238d1156 docs 2024-08-22 14:12:04 +01:00
Will McGugan
4f3c7666e5 SystemCommand 2024-08-22 14:04:54 +01:00
Will McGugan
1d1e538e10 words 2024-08-22 13:17:13 +01:00
Will McGugan
bc54961e15 wording 2024-08-22 13:16:52 +01:00
Will McGugan
7a9ab93826 docs 2024-08-22 12:37:30 +01:00
Will McGugan
9f66043291 added help 2024-08-22 12:21:23 +01:00
Will McGugan
b1849e36ef snapshot 2024-08-22 12:08:48 +01:00
Will McGugan
1344493448 docs 2024-08-11 19:03:54 +01:00
Will McGugan
c1fb5df0ea words 2024-08-06 11:13:51 +01:00
Will McGugan
e0e3f8d1ff no copy 2024-08-01 12:06:33 +01:00
Will McGugan
cfd100ee24 typo 2024-07-29 14:21:28 +01:00
Will McGugan
63838d1786 docs 2024-07-29 13:59:01 +01:00
Will McGugan
2f2f3142bc update titles 2024-07-17 17:37:41 +01:00
Will McGugan
4c11d09315 docs 2024-07-12 16:23:18 +01:00
Will McGugan
78b2a6670a docs 2024-07-12 16:09:05 +01:00
Darren Burns
cac4ae381c
Don't sort "discover" items in the command palette (#4720)
* Dont sort discovery items in command palette

* Update CHANGELOG.md

* Updating snapshot tests for command palette ordering change

* Fix snapshot tests

* Remove irrelevant docs
2024-07-10 16:39:36 +01:00
Will McGugan
c6fdd71b89 fix docs 2024-06-16 17:43:03 +01:00
Will McGugan
ae49d55b75 fix typo 2024-06-16 17:16:19 +01:00
Will McGugan
c2eff2d9c5 Screen events 2024-06-06 19:30:50 +01:00
Will McGugan
3eca5255b2
Update docs/guide/actions.md
Co-authored-by: TomJGooding <101601846+TomJGooding@users.noreply.github.com>
2024-05-17 19:21:44 +01:00
Will McGugan
9459c03dea
Update docs/guide/actions.md
Co-authored-by: TomJGooding <101601846+TomJGooding@users.noreply.github.com>
2024-05-17 19:21:32 +01:00
Will McGugan
762c2ca37b typos 2024-05-17 19:21:06 +01:00
Will McGugan
5e898baa1b bindings 2024-05-17 19:18:54 +01:00
Will McGugan
c9828e5c2e snapshots 2024-05-17 17:55:32 +01:00
Will McGugan
ce93741ff6 typos 2024-05-17 17:44:02 +01:00
Will McGugan
e0942cf499 dynamic actions docs 2024-05-17 17:33:00 +01:00
Darren Burns
fdfe104dc4 Add note about inline-mode to the docs 2024-05-10 16:14:59 +01:00
Will McGugan
e4c57557f8 extra words 2024-05-08 17:08:13 +01:00
Dave Pearson
508cba63ce
Typo fix (s/are/is/) 2024-05-07 21:41:43 +01:00
Will McGugan
a9e87b59c0 query_one docs 2024-05-07 21:09:33 +01:00
TomJGooding
d788bcf771 docs: update TabActivated on decorator selector 2024-04-17 18:15:48 +01:00
Will McGugan
762bc36179 link to tqs 2024-04-09 10:12:16 +01:00
TomJGooding
bca7ea7eac docs(app): fix version inline mode was added 2024-04-01 13:44:35 +01:00
Will McGugan
2396905ac0
Merge pull request #4343 from Textualize/inline
inline driver
2024-03-30 13:34:15 +00:00
Will McGugan
18a556b605 tweak 2024-03-30 13:25:41 +00:00
Will McGugan
cc19158a9a inline docs 2024-03-30 13:21:29 +00:00
Will McGugan
95de754cd3 docs 2024-03-30 09:42:27 +00:00
Will McGugan
5606a40f07 don't make demo inline 2024-03-30 09:00:18 +00:00
Will McGugan
ea63e8e0b4 Note about run inline 2024-03-29 16:36:44 +00:00
Valentin Grégoire
f05d727c01
fix: Fix the fix to fix the typo 😵. 2024-03-28 09:22:55 +01:00
Valentin Grégoire
2a06e288ea
fix: Typo fixed. 2024-03-28 09:22:27 +01:00
TomJGooding
1060790470 docs(devtools): add worker to log groups 2024-02-27 21:26:11 +00:00
Darren Burns
e22f081876
Animation docs fix (#4226)
* Docstring fixes

* Hardcoding the animation steps to fix animation docs example

* Calling ease correctly
2024-02-27 16:38:18 +00:00
Will McGugan
f8be478ccb
Update docs/guide/reactivity.md
Co-authored-by: Rodrigo Girão Serrão <5621605+rodrigogiraoserrao@users.noreply.github.com>
2024-02-26 14:24:05 +00:00
Will McGugan
ba13c3c390
Update docs/guide/reactivity.md
Co-authored-by: Rodrigo Girão Serrão <5621605+rodrigogiraoserrao@users.noreply.github.com>
2024-02-26 14:23:55 +00:00
Will McGugan
14c5ac8dea redundant 2024-02-26 13:34:03 +00:00
Will McGugan
45e9cd6062 comma 2024-02-26 13:33:24 +00:00
Will McGugan
274c0f6c08 words 2024-02-25 18:30:42 +00:00
Will McGugan
3093d5297c recompose docs 2024-02-25 18:24:45 +00:00
Will McGugan
e701a8fad3 docs 2024-02-25 17:07:12 +00:00
TomJGooding
5aaa6b539c
docs: fix tcss syntax highlighting (#4176)
Sorry but I spotted that the syntax highlighting was wrong in my last PR to
add tcss to the docs (#4171) where I had blindly copy pasted the code.

A quick grep found a few other places in the docs where the syntax
highlighting was wrong. This PR corrects the language to css.
2024-02-21 08:37:56 +00:00
TomJGooding
c680bd7905 docs(events): add tcss to on decorator examples 2024-02-16 17:41:55 +00:00
Dave Pearson
3971449c16
Tidy up a suggested edit to the discover docs 2024-02-15 09:37:47 +00:00
Dave Pearson
efb8b48347
Tweak the layout of the discover description
Co-authored-by: Rodrigo Girão Serrão <5621605+rodrigogiraoserrao@users.noreply.github.com>
2024-02-15 09:28:45 +00:00
Dave Pearson
66c19fab01
Make it clear we're talking about discovery hits 2024-02-14 10:20:46 +00:00
Dave Pearson
4f6f15a066
Add a note about best practice of the user of discover 2024-02-14 10:08:54 +00:00
Dave Pearson
cbb44bb50c
Mention the discover method in the docs 2024-02-14 10:06:00 +00:00
Dave Pearson
a705c34965
Fix a case typo that already existed in the document 2024-02-14 10:05:38 +00:00
Will McGugan
f39a7c96d3
Update docs/guide/reactivity.md
Co-authored-by: Darren Burns <darrenburns@users.noreply.github.com>
2024-02-06 16:26:39 +00:00
Will McGugan
a817ecb999 docs 2024-02-06 14:58:07 +00:00
Will McGugan
f20515d4ae reactive docs 2024-02-06 14:30:27 +00:00
Will McGugan
fa8c0e8f95 fix refresh lines 2024-02-05 21:16:26 +00:00
TomJGooding
7c5f291704 docs(suspend): fix example highlighted lines 2024-02-01 17:06:58 +00:00
Dave Pearson
025ac85bb1
Add action_suspend_process to the list of builtin actions 2024-01-31 12:48:21 +00:00
Dave Pearson
1cd64f974f
Add a full app to show off action_suspend_process binding 2024-01-31 12:47:10 +00:00
Dave Pearson
c916a82934
Include the output of the suspend example in the docs 2024-01-31 11:36:14 +00:00
Dave Pearson
0003b52dcf
Celebrate vim in the docs
Co-authored-by: Will McGugan <willmcgugan@gmail.com>
2024-01-31 11:09:44 +00:00
Dave Pearson
7fb59d1831
Docs wording tweak
Co-authored-by: Will McGugan <willmcgugan@gmail.com>
2024-01-31 11:08:29 +00:00
Dave Pearson
d94c2f9da1
Improve a heading in the docs
Co-authored-by: Will McGugan <willmcgugan@gmail.com>
2024-01-31 11:08:03 +00:00
Dave Pearson
3914215636
Simplify a caveat in the docs
Co-authored-by: Will McGugan <willmcgugan@gmail.com>
2024-01-31 11:07:37 +00:00
Dave Pearson
dca798f574
Improve documentation
Co-authored-by: Will McGugan <willmcgugan@gmail.com>
2024-01-31 11:06:55 +00:00
Dave Pearson
b73523ab8a
Remove Ctrl+Z as the default binding for suspending
While this is the convention/standard on Unix and Unix-like systems; adding
this as a default binding on App means that we sort of rob other
environments for this key combination. It also means that it's not so easy
for the developer to decide they *don't* want this enabled in their
application.

So here we swap to providing the action without providing a default binding
for it; while also suggesting and encouraging the appropriate binding.
2024-01-30 14:04:35 +00:00