Commit Graph

479 Commits

Author SHA1 Message Date
Dave Pearson
34e5d53cb3 Correct what is imported in an example
The main code in the example creates a `Button` from a `Static`, but the
import is importing a `Widget`. This commit makes the example code make more
sense.
2022-10-14 08:48:06 +01:00
Dave Pearson
d324f1cd56 Add a missing word 2022-10-14 08:42:11 +01:00
Dave Pearson
e46c51d61c Fix whitespace
Includes pre-commit hook changes.
2022-10-14 08:41:02 +01:00
Dave Pearson
e280719816 Singular style 2022-10-13 22:14:14 +01:00
Dave Pearson
e583d21165 it's -> its 2022-10-13 22:10:46 +01:00
Dave Pearson
c37c5569d7 Add what appears to be a missing "at" 2022-10-13 22:01:16 +01:00
Dave Pearson
bfed4a6bf9 Fix the mention of an example to be singular 2022-10-13 22:00:17 +01:00
Dave Pearson
19c29bdb11 Add code markup to string constants
Elsewhere in the document colour names as strings have been marked up as
text, so this is in keeping with that.
2022-10-13 21:57:08 +01:00
Dave Pearson
279b043c81 Add missing plural 2022-10-13 21:55:49 +01:00
Dave Pearson
bd21a255ad Add missing "we" 2022-10-13 21:53:16 +01:00
Dave Pearson
8b45cd5324 Remove trailing whitespace 2022-10-13 21:49:46 +01:00
Dave Pearson
658a2c6017 Merge branch 'css' into css-docs-review 2022-10-13 21:38:16 +01:00
Dave Pearson
31a1ebbe8f s/you/your/ 2022-10-13 16:36:30 +01:00
Dave Pearson
7182c79814 Lets to let's 2022-10-13 15:46:17 +01:00
Dave Pearson
c4a43c3f52 s/Mypy/mypy/ 2022-10-13 15:44:46 +01:00
Dave Pearson
ffbccd5d5d Add code markup to the mention of class names 2022-10-13 15:42:01 +01:00
Dave Pearson
4569a77d54 Add code markup to the mention of a class name 2022-10-13 15:40:55 +01:00
Dave Pearson
da49d19cb7 s/fledge/fledged/ 2022-10-13 15:40:03 +01:00
Dave Pearson
e736611b55 Remove trailing whitespace 2022-10-13 15:34:10 +01:00
Dave Pearson
25fcf26a30 Add code markup to the mention of a class names 2022-10-13 15:31:34 +01:00
Dave Pearson
4a6e4ff025 Reword the details of how textual run finds an app
It seems the docs are lagging behind the code here, so this commit attempts
to update them so they're more in line with how `textual run` works.
2022-10-13 15:26:54 +01:00
Dave Pearson
ceb531e535 Add code markup to the mention of a class name 2022-10-13 14:46:39 +01:00
Dave Pearson
7676a6cf4c Trailing whitespace cleanup 2022-10-13 14:45:54 +01:00
Dave Pearson
bd43f0466a Harmonise the tutorial's markup of filenames
In some cases filenames where `marked-up.py`, in other cases they were
"marked-up.py", and in some cases they were just mentioned with
no-markup.py. This commit seeks to make all filename mentions, in text, the
same.
2022-10-13 14:41:10 +01:00
Dave Pearson
a342a2cb53 Add code markup to the mention of a class name 2022-10-13 14:37:03 +01:00
Dave Pearson
d6a2c88713 Add code markup to a number of code-oriented things in a line 2022-10-13 14:35:39 +01:00
Dave Pearson
45db071bb5 Add missing end quote to a string 2022-10-13 14:32:20 +01:00
Dave Pearson
1dbde34b40 Add code markup a string that is a class
Elsewhere a string that is a class is marked up this way, so let's follow
that earlier standard.
2022-10-13 14:31:32 +01:00
Dave Pearson
86b5612c9f Lower-case mention of stopwatches
This looks more like it's been used as a normal word, rather than as a
plural for the class.
2022-10-13 14:28:04 +01:00
Dave Pearson
be36c55d37 Add code markup to the mention of a class name 2022-10-13 14:26:44 +01:00
Dave Pearson
ed20f4a8e6 Add code markup a string that is a widget ID
Elsewhere in the docs we see `"something"` for a class, so I feel it follows
that "#something" should really be `"#something"` too.
2022-10-13 14:23:26 +01:00
Dave Pearson
e109599a97 Add code markup to the mention of a class name 2022-10-13 14:21:39 +01:00
Dave Pearson
758ddfa86f Add code markup to the mention of a method name 2022-10-13 14:20:41 +01:00
Dave Pearson
50fb723965 Add code markup to the mention of a class name 2022-10-13 14:19:50 +01:00
Dave Pearson
2e25c894e3 Add code markup to the mention of a class name 2022-10-13 14:18:23 +01:00
Dave Pearson
82499c31e7 Capital at the start of a sentence 2022-10-13 14:16:24 +01:00
Dave Pearson
93e403c8dc Mark mention of Widget as a class as code 2022-10-13 14:11:12 +01:00
Dave Pearson
a90a2fd728 Correct the name of mypy
It seems that mypy's preference for its name is mypy (or even my[py]), but
not Mypy.
2022-10-13 13:45:34 +01:00
Dave Pearson
91a13406e6 Remove trailing whitespace
Including one instance that I wouldn't have, but the pre-commit hooks have,
and it seems fine.
2022-10-13 13:41:10 +01:00
Darren Burns
7f24a6dfa5 Remove E2E tests (snapshot covers same functionality), move custom theme into docs folder 2022-10-13 12:44:20 +01:00
Dave Pearson
bf1ad06edb Merge pull request #888 from davep/css-docs-screen-import
Modify the screen examples to import Screen from textual.screen
2022-10-13 11:12:07 +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
Dave Pearson
78ea2cd9f8 Modify the screen examples to import Screen from textual.screen
The surrounding text in the documentation states that Screen is imported
from textual.screen, but the code was importing the class from textual.app.
Further, I was getting warnings from pyright that I was using a class that
wasn't exported from the module I was importing from.
2022-10-13 09:10:40 +01:00
Aaron Stephens
b9493ae6ff docs: typos 2022-10-12 17:34:29 -07:00
Will McGugan
010ccbcd6d Merge pull request #868 from Textualize/document-links
Document links
2022-10-12 15:31:35 +01:00
Will McGugan
1da5c297ad Merge pull request #859 from davep/layout-typo-squish
Typo fix: `styles` belong to a widget
2022-10-11 15:00:25 +01:00
Darren Burns
50bd8f3ec2 Add a TODO 2022-10-11 11:34:53 +01:00
Darren Burns
3619b8f27a Make example link italic in dos 2022-10-11 11:26:04 +01:00
Darren Burns
ba94892bdd Remove CSS that wasnt needed 2022-10-11 11:22:46 +01:00