Dave Pearson
3478615592
Add a class docstring to ListItem
2023-03-01 11:48:13 +00:00
Dave Pearson
43cc67d254
Add a module docstring to _list_item.py
2023-03-01 11:44:36 +00:00
Dave Pearson
11e16b406a
Remove unused import in _text_log.py
2023-03-01 11:23:34 +00:00
Dave Pearson
42718869f1
Tidy up the TextLog.write docstring
2023-03-01 10:47:32 +00:00
Dave Pearson
8b22875e37
Fix TextLog.__init__ copy/paste-os
2023-03-01 10:45:58 +00:00
Dave Pearson
c0cc080b7c
Be explicit about the type of TextLog.max_lines
2023-03-01 10:44:59 +00:00
Dave Pearson
c619984845
Add a docstring to TextLog
2023-03-01 10:44:20 +00:00
Dave Pearson
74526c1902
Add a module docstring to _text_log
2023-03-01 10:42:14 +00:00
Dave Pearson
87f216980d
Add the Welcome widget to the documentation
...
While it's arguably not the most useful widget, it's in the code, exported,
and can be seen by people; I feel it should be in the documentation. I've
ensured that it also links to Placeholder given it sort of is a Placeholder
and so people might arrive at it first and it makes sense to redirect them
to something more comprehensive.
2023-03-01 10:39:30 +00:00
Dave Pearson
ed2d547fcf
Add docstrings to the Welcome widget
2023-03-01 10:39:08 +00:00
Dave Pearson
287ef15c24
Add a module docstring for Header
2023-03-01 10:27:12 +00:00
Dave Pearson
61aa558d78
Document Header.tall
2023-03-01 10:26:07 +00:00
Dave Pearson
4258698855
Document all of the Header __init__ arguments
2023-03-01 10:25:26 +00:00
Dave Pearson
766cae2f47
Make Header.show_clock private
...
Header.show_clock was just a good old plain object attribute, not a
reactive, and also wasn't done as a read-only property. This means someone
could get the impression that it could be modified on the fly and the header
would react.
There might be an argument for turning it into that; but for the moment this
commit makes it private so that nobody gets the wrong impression.
2023-03-01 10:20:47 +00:00
Dave Pearson
b071121af7
Migrate the HeaderTitle.render return type hint to RenderResult
2023-03-01 10:17:06 +00:00
Dave Pearson
4a505e8a6c
Add a docstring to HeaderTitle.render
2023-03-01 10:16:31 +00:00
Dave Pearson
d0dedc0fde
Add a docsrtring for HeaderTitle.sub_text
2023-03-01 10:13:18 +00:00
Dave Pearson
318e129876
Add a docsrtring for HeaderTitle.text
2023-03-01 10:12:48 +00:00
Dave Pearson
27e1311ee0
Flesh out the HeaderClock.render docstring
2023-03-01 10:12:11 +00:00
Dave Pearson
f96eb93a60
Add missing return type to HeaderClock.render
2023-03-01 10:11:37 +00:00
Dave Pearson
cfb21d0728
Flesh out the HeaderClockSpace.render docstring
2023-03-01 10:11:05 +00:00
Dave Pearson
ac18b00c98
Improve the return type of HeaderClockSpace.render
2023-03-01 10:10:29 +00:00
Dave Pearson
3602dab06c
Flesh out the HeaderIcon.render docstring
2023-03-01 10:09:54 +00:00
Dave Pearson
597b46fb11
Add missing return type to HeaderIcon.render
2023-03-01 10:09:11 +00:00
Dave Pearson
fb02fde9dc
Add a docstring for HeaderIcon.icon
2023-03-01 10:07:41 +00:00
Will McGugan
5d6f6a12ed
Merge pull request #1903 from davep/doc-coordinate
...
Add property docstrings to Coordinate
2023-02-28 17:18:37 +00:00
Dave Pearson
e8732c3013
Add property docstrings to Coordinate
2023-02-28 16:33:34 +00:00
Dave Pearson
c5448128e1
Merge pull request #1898 from davep/extend-api-docs-linkage
...
Increase the coverage of API documentation
2023-02-28 16:18:24 +00:00
Will McGugan
cc8436de18
Merge pull request #1900 from Textualize/composit-region-refactor
...
Added DEBUG switch, scrollbar_size property, fixed text_log line length
2023-02-28 15:50:11 +00:00
Will McGugan
129a4fe386
superfluous docstring
2023-02-28 15:43:23 +00:00
Will McGugan
9ccff28e9f
clarification in docstring
2023-02-28 15:38:36 +00:00
Will McGugan
5af39325e5
Removed unused symbol
2023-02-28 15:07:29 +00:00
Will McGugan
e336ac2689
sort order
2023-02-28 13:47:45 +00:00
Will McGugan
dec2a3b5b0
fix typing
2023-02-28 13:47:11 +00:00
Will McGugan
6f8d0ce076
Added apply_style to Strip
2023-02-28 13:41:46 +00:00
Will McGugan
50efb878ae
Merge pull request #1899 from davep/tidy-binding-docstring
...
Simplify Bindings.shown_keys docstring
2023-02-28 13:26:49 +00:00
Dave Pearson
c30c09adc3
Simplify Bindings.shown_keys docstring
...
In the public interface it's a property, not a method, so it doesn't need a
'Returns'.
2023-02-28 13:06:09 +00:00
Dave Pearson
ce5b02522e
Document AwaitRemove
2023-02-28 12:50:41 +00:00
Dave Pearson
8d2336a02e
Increase the coverage of API documentation
...
See #1364 -- rather than pull in specific classes, this pulls in every
publicly-documented item (function, class, type, "constant", etc) that can
be found in each of the modules.
This should help improve the linkage of types within the documentation.
2023-02-28 12:27:22 +00:00
Will McGugan
7e7d24d880
Added DEBUG switch, scrollbar_size property, fixed text_log line length
2023-02-28 08:54:39 +00:00
Will McGugan
80ae6ce4d9
Update task.md
2023-02-27 16:19:31 +00:00
Dave Pearson
0ee5323653
Merge pull request #1893 from davep/more-action-docs
...
Add a docstring to Input.action_submit
2023-02-27 16:09:16 +00:00
Dave Pearson
eb2b3fa4ea
Add a docstring to Input.action_submit
2023-02-27 15:23:07 +00:00
Dave Pearson
9f77208fef
Merge pull request #1872 from davep/toggle-boxen
...
Add `Checkbox`, `RadioButton` and `RadioSet`
2023-02-27 15:15:51 +00:00
Dave Pearson
df6f7bd8da
Don't bubble up any Changed event when stopping all-off on radio set
2023-02-27 14:03:54 +00:00
Dave Pearson
d8ae11d646
Drop a vestigial cast
2023-02-27 13:53:09 +00:00
Dave Pearson
201ab4eb72
Move RadioSet.Changed near the top of the class
...
As requested in https://github.com/Textualize/textual/pull/1872#discussion_r1118627015
Personally my preference tends to run to having inner-classes defined close
to where they're used, but I can't think of a good reason not to do it this
way either.
2023-02-27 13:46:52 +00:00
Dave Pearson
47eb9f0064
Typo fix
2023-02-27 13:45:43 +00:00
Dave Pearson
dec9a77304
Fix a docstring typo
...
Co-authored-by: Rodrigo Girão Serrão <5621605+rodrigogiraoserrao@users.noreply.github.com >
2023-02-27 13:35:54 +00:00
Dave Pearson
b5c028c36d
Fix a docstring typo
...
Co-authored-by: Rodrigo Girão Serrão <5621605+rodrigogiraoserrao@users.noreply.github.com >
2023-02-27 13:35:33 +00:00