Code

Widget documentation sweep#1909

Code

Merged

davep merged 95 commits intoTextualize:mainTextualize/textual:mainfrom davep:widget-doc-sweepdavep/textual:widget-doc-sweepCopy head branch name to clipboardMar 1, 2023

+303-178

Commits

Commits on Mar 1, 2023

• Add a docstring for HeaderIcon.icon

  davep

  committed
  fb02fde

• Add missing return type to HeaderIcon.render

  davep

  committed
  597b46f

• Flesh out the HeaderIcon.render docstring

  davep

  committed
  3602dab

• Improve the return type of HeaderClockSpace.render

  davep

  committed
  ac18b00

• Flesh out the HeaderClockSpace.render docstring

  davep

  committed
  cfb21d0

• Add missing return type to HeaderClock.render

  davep

  committed
  f96eb93

• Flesh out the HeaderClock.render docstring

  davep

  committed
  27e1311

• Add a docsrtring for HeaderTitle.text

  davep

  committed
  318e129

• Add a docsrtring for HeaderTitle.sub_text

  davep

  committed
  d0dedc0

• Add a docstring to HeaderTitle.render

  davep

  committed
  4a505e8

• Migrate the HeaderTitle.render return type hint to RenderResult

  davep

  committed
  b071121

• Make Header.show_clock private

  Show description for 766cae2
  davep

  committed
  766cae2

• Document all of the Header __init__ arguments

  davep

  committed
  4258698

• Document Header.tall

  davep

  committed
  61aa558

• Add a module docstring for Header

  davep

  committed
  287ef15

• Add docstrings to the Welcome widget

  davep

  committed
  ed2d547

• Add the Welcome widget to the documentation

  Show description for 87f2169
  davep

  committed
  87f2169

• Add a module docstring to _text_log

  davep

  committed
  74526c1

• Add a docstring to TextLog

  davep

  committed
  c619984

• Be explicit about the type of TextLog.max_lines

  davep

  committed
  c0cc080

• Fix TextLog.__init__ copy/paste-os

  davep

  committed
  8b22875

• Tidy up the TextLog.write docstring

  davep

  committed
  4271886

• Remove unused import in _text_log.py

  davep

  committed
  11e16b4

• Add a module docstring to _list_item.py

  davep

  committed
  43cc67d

• Add a class docstring to ListItem

  davep

  committed
  3478615

• Add a docstring to ListItem.highlighted

  davep

  committed
  a326169

• Remove unnecessary pass

  davep

  committed
  d4ef173

• Add a module docstring to _placeholder.py

  davep

  committed
  a4f22d0

• Remove unused import

  davep

  committed
  5a61459

• Type TextLog.max_lines in a way that works in all Pythons

  Show description for bba5017
  davep

  committed
  bba5017

• Add a docstring to PlaceholderVariant

  davep

  committed
  d50fcc7

• Add a docstring to Placeholder.variant

  davep

  committed
  46bf558

• Add a docstring to Placeholder.render

  davep

  committed
  8f9cf74

• Remove defaults from the Placeholder.__init__ docstring args

  davep

  committed
  4971e0e

• Add a module docstring for _pretty.py

  davep

  committed
  9c45c7d

• Add a class docstring for the Pretty widget.

  davep

  committed
  75625ef

• Add a docstring to Pretty.__init__

  davep

  committed
  52adf3f

• Add a docstring for Pretty.render

  davep

  committed
  7ca3357

• Add a docstring to Pretty.update

  davep

  committed
  865a8e5

• Add a missing

  davep

  committed
  662c1d8

• Add a module docstring to _tree.py

  davep

  committed
  e21e552

• Ensure PlaceholderVariant gets included in the docs

  davep

  committed
  a837cd1

• Document TreeNode via Tree itself

  Show description for ac35c1d
  davep

  committed
  ac35c1d

• Document NodeID

  Show description for dbb5263
  davep

  committed
  dbb5263

• Add a docstring for TreeNode.__init__

  davep

  committed
  3192ee7

• Add a docstring for TreeNode.data

  davep

  committed
  3658610

• Reword the documentation for TreeNode.line

  Show description for 6e836de
  davep

  committed
  6e836de

• Reword the documentation for TreeNode.id

  Show description for 3f90812
  davep

  committed
  3f90812

• Reword the documentation for TreeNode.is_expanded

  Show description for e8d0f7a
  davep

  committed
  e8d0f7a

• Reword the documentation for TreeNode.is_last

  Show description for 65ba559
  davep

  committed
  65ba559

• Reword the documentation for TreeNode.allow_expand

  Show description for 2e060c0
  davep

  committed
  2e060c0

• Improve the docstring for TreeNode.set_label

  davep

  committed
  acb1cc6

• Remove default information from TreeNode.add_leaf's docstring

  davep

  committed
  6d03829

• Add a class docstring to Tree

  davep

  committed
  106c5aa

• Reorder the declaration of the Tree COMPONENT_CLASSES

  Show description for fa1f699
  davep

  committed
  fa1f699

• Document TreeDataType

  davep

  committed
  80fd76f

• Add a docstring to Tree.__init__

  davep

  committed
  40b41a1

• Document Tree.root

  davep

  committed
  8917bb6

• Improve the docstring of Tree.process_label

  Show description for 3850070
  davep

  committed
  3850070

• Improve the docstring of Tree.validate_cursor_line

  davep

  committed
  fb5a10a

• Improve the docstring of Tree.validate_guide_depth

  davep

  committed
  b73cd78

• Add a docstring for EventTreeDataType

  davep

  committed
  abdcf2f

• Tidy up the docstring of Widget.scroll_to

  Show description for 21e7cfb
  davep

  committed
  21e7cfb

• Tidy up the docstring of Widget.scroll_relative

  Show description for 22b0b5b
  davep

  committed
  22b0b5b

• Tidy up the docstring of Widget.scroll_home

  Show description for 48dd54c
  davep

  committed
  48dd54c

• Tidy up the docstring of Widget.scroll_end

  Show description for af6d56c
  davep

  committed
  af6d56c

• Merge branch 'main' into widget-doc-sweep

  davep

  committed
  cf34e5e

• Tidy up the docstring of Widget._scroll_to

  Show description for 2fce894
  davep

  committed
  2fce894

• Tidy up the docstring of Widget.scroll_to

  Show description for 52b69d5
  davep

  committed
  52b69d5

• Tidy the wording of a docstring

  davep

  committed
  88f771b

• Tidy up the docstring of Widget.scroll_left

  Show description for ee126a9
  davep

  committed
  ee126a9

• Tidy up the docstring of Widget._scroll_left_for_pointer

  Show description for 30d8943
  davep

  committed
  30d8943

• Remove another default value from Widget.scroll_left

  Show description for ef29a77
  davep

  committed
  ef29a77

• Tidy up the docstring of Widget.scroll_right

  Show description for acaec34
  davep

  committed
  acaec34

• Tidy up the docstring of Widget._scroll_right_for_pointer

  Show description for e8537c6
  davep

  committed
  e8537c6

• Tidy up the docstring of Widget.scroll_down

  Show description for 2deb90e
  davep

  committed
  2deb90e

• Tidy up the docstring of Widget._scroll_down_for_pointer

  Show description for 0992b36
  davep

  committed
  0992b36

• Add some missing markup

  davep

  committed
  f8167ac

• Tidy up the docstring of Widget.scroll_up

  Show description for ca1abcf
  davep

  committed
  ca1abcf

• Tidy up the docstring of Widget._scroll_up_for_pointer

  Show description for b617d67
  davep

  committed
  b617d67

• Tidy up the docstring of Widget.scroll_page_up

  Show description for 3122748
  davep

  committed
  3122748

• Tidy up the docstring of Widget.scroll_page_down

  Show description for ab963d2
  davep

  committed
  ab963d2

• Tidy up the docstring of Widget.scroll_page_left

  Show description for ce016d5
  davep

  committed
  ce016d5

• Tidy up the docstring of Widget.scroll_page_right

  Show description for 5afbf48
  davep

  committed
  5afbf48

• Tidy up the docstring of Widget.scroll_to_widget

  Show description for 53b0e54
  davep

  committed
  53b0e54

• Tidy up the docstring of Widget.scroll_to_region

  Show description for 24fa963
  davep

  committed
  24fa963

• Final back-read, typo squishing and markup-fixing

  Show description for aa96b54
  davep

  committed
  aa96b54

• Merge branch 'main' into widget-doc-sweep

  davep

  authored
  847e2cc

• Code tidy

  Show description for 768d4ae
  davep

  committed
  768d4ae

• Improved wording

  Show description for 348fbe2
  

  davep

  and

  rodrigogiraoserrao

  authored
  348fbe2

• Improved wording

  Show description for b1c6da2
  

  davep

  and

  rodrigogiraoserrao

  authored
  b1c6da2

• Improved wording

  Show description for b3fe97e
  

  davep

  and

  rodrigogiraoserrao

  authored
  b3fe97e

• Improved wording

  Show description for 88fcf4f
  

  davep

  and

  rodrigogiraoserrao

  authored
  88fcf4f

• Improved wording

  Show description for 5cfa998
  

  davep

  and

  rodrigogiraoserrao

  authored
  5cfa998

• Remove omit a unnecessary word

  Show description for d9ab2ac
  

  davep

  and

  rodrigogiraoserrao

  authored
  d9ab2ac