Dave Pearson
9fa10ecc18
Interlink the docs with the Python and Rich manuals
...
All through our docs there are mentions of Python types and also Rich types.
This change will make the vast majority of mentions of them into actual
links that people can follow. So now, for example, when someone sees a
method that returns a `Style`, they can click on it and see what a `Style`
actually is.
2023-03-01 15:42:38 +00:00
Dave Pearson
aa96b54263
Final back-read, typo squishing and markup-fixing
...
Delivering on a promise made in #1920 .
2023-03-01 14:59:36 +00:00
Dave Pearson
24fa963241
Tidy up the docstring of Widget.scroll_to_region
...
Delivering on a promise made in #1920 .
2023-03-01 14:54:28 +00:00
Dave Pearson
53b0e54e9d
Tidy up the docstring of Widget.scroll_to_widget
...
Delivering on a promise made in #1920 .
2023-03-01 14:53:59 +00:00
Dave Pearson
5afbf48ef4
Tidy up the docstring of Widget.scroll_page_right
...
Delivering on a promise made in #1920 .
2023-03-01 14:49:45 +00:00
Dave Pearson
ce016d57e2
Tidy up the docstring of Widget.scroll_page_left
...
Delivering on a promise made in #1920 .
2023-03-01 14:49:15 +00:00
Dave Pearson
ab963d2eb6
Tidy up the docstring of Widget.scroll_page_down
...
Delivering on a promise made in #1920 .
2023-03-01 14:48:35 +00:00
Dave Pearson
3122748303
Tidy up the docstring of Widget.scroll_page_up
...
Delivering on a promise made in #1920 .
2023-03-01 14:47:56 +00:00
Dave Pearson
b617d67f3d
Tidy up the docstring of Widget._scroll_up_for_pointer
...
Delivering on a promise made in #1920 .
2023-03-01 14:46:25 +00:00
Dave Pearson
ca1abcff5c
Tidy up the docstring of Widget.scroll_up
...
Delivering on a promise made in #1920 .
2023-03-01 14:45:47 +00:00
Dave Pearson
f8167ac35e
Add some missing markup
2023-03-01 14:44:36 +00:00
Dave Pearson
0992b3650d
Tidy up the docstring of Widget._scroll_down_for_pointer
...
Delivering on a promise made in #1920 .
2023-03-01 14:43:55 +00:00
Dave Pearson
2deb90eb8d
Tidy up the docstring of Widget.scroll_down
...
Delivering on a promise made in #1920 .
2023-03-01 14:43:14 +00:00
Dave Pearson
e8537c6c65
Tidy up the docstring of Widget._scroll_right_for_pointer
...
Delivering on a promise made in #1920 .
2023-03-01 14:41:07 +00:00
Dave Pearson
acaec3435f
Tidy up the docstring of Widget.scroll_right
...
Delivering on a promise made in #1920 .
2023-03-01 14:40:24 +00:00
Dave Pearson
ef29a77315
Remove another default value from Widget.scroll_left
...
Delivering on a promise made in #1920 .
2023-03-01 14:39:14 +00:00
Dave Pearson
30d894314b
Tidy up the docstring of Widget._scroll_left_for_pointer
...
Delivering on a promise made in #1920 .
2023-03-01 14:38:52 +00:00
Dave Pearson
ee126a9427
Tidy up the docstring of Widget.scroll_left
...
Delivering on a promise made in #1920 .
2023-03-01 14:37:30 +00:00
Dave Pearson
88f771b4e1
Tidy the wording of a docstring
2023-03-01 14:36:31 +00:00
Dave Pearson
52b69d50d0
Tidy up the docstring of Widget.scroll_to
...
Delivering on a promise made in #1920 .
2023-03-01 14:35:38 +00:00
Dave Pearson
2fce894b90
Tidy up the docstring of Widget._scroll_to
...
Delivering on a promise made in #1920 .
2023-03-01 14:34:11 +00:00
Dave Pearson
cf34e5e7fa
Merge branch 'main' into widget-doc-sweep
2023-03-01 14:32:47 +00:00
Dave Pearson
af6d56cf8e
Tidy up the docstring of Widget.scroll_end
...
Delivering on a promise made in #1920 .
2023-03-01 14:25:03 +00:00
Dave Pearson
48dd54c481
Tidy up the docstring of Widget.scroll_home
...
Delivering on a promise made in #1920 .
2023-03-01 14:23:38 +00:00
Dave Pearson
22b0b5b047
Tidy up the docstring of Widget.scroll_relative
...
Delivering on a promise made in #1920 .
2023-03-01 14:22:34 +00:00
Dave Pearson
21e7cfb9ca
Tidy up the docstring of Widget.scroll_to
...
Delivering on a promise made in #1920 .
2023-03-01 14:17:01 +00:00
Dave Pearson
abdcf2fea8
Add a docstring for EventTreeDataType
2023-03-01 14:10:45 +00:00
Dave Pearson
b73cd781be
Improve the docstring of Tree.validate_guide_depth
2023-03-01 14:08:03 +00:00
Dave Pearson
fb5a10a835
Improve the docstring of Tree.validate_cursor_line
2023-03-01 14:07:22 +00:00
Dave Pearson
3850070fd9
Improve the docstring of Tree.process_label
...
Also give it a return type hint to match the docs.
2023-03-01 14:05:11 +00:00
Dave Pearson
8917bb6da2
Document Tree.root
2023-03-01 13:50:08 +00:00
Dave Pearson
40b41a1b93
Add a docstring to Tree.__init__
2023-03-01 13:48:58 +00:00
Dave Pearson
80fd76f1f2
Document TreeDataType
2023-03-01 13:45:32 +00:00
Dave Pearson
fa1f699161
Reorder the declaration of the Tree COMPONENT_CLASSES
...
The only benefit here (which is a good benefit) being that the order will
match the docstring below so it'll be easier to keep track of if everything
is in the docstring or not.
2023-03-01 13:41:32 +00:00
Dave Pearson
a283689d1d
Merge pull request #1913 from davep/pre-commit-install-makefile-target
...
Add a Makefile target for installing pre-commit hooks
2023-03-01 13:40:33 +00:00
Dave Pearson
106c5aa2c8
Add a class docstring to Tree
2023-03-01 13:35:24 +00:00
Dave Pearson
6d038299fd
Remove default information from TreeNode.add_leaf's docstring
2023-03-01 13:32:34 +00:00
Dave Pearson
acb1cc61fc
Improve the docstring for TreeNode.set_label
2023-03-01 13:31:39 +00:00
Dave Pearson
2e060c07d7
Reword the documentation for TreeNode.allow_expand
...
Make it more property-like.
2023-03-01 13:30:44 +00:00
Dave Pearson
65ba559943
Reword the documentation for TreeNode.is_last
...
Make it more property-like.
2023-03-01 13:30:06 +00:00
Dave Pearson
e8d0f7a50f
Reword the documentation for TreeNode.is_expanded
...
Make it more property-like.
2023-03-01 13:29:18 +00:00
Dave Pearson
3f90812743
Reword the documentation for TreeNode.id
...
Make it more property-like.
2023-03-01 13:28:47 +00:00
Dave Pearson
6e836de1ef
Reword the documentation for TreeNode.line
...
Make it more property-like.
2023-03-01 13:28:03 +00:00
Dave Pearson
3658610792
Add a docstring for TreeNode.data
2023-03-01 13:27:16 +00:00
Dave Pearson
3192ee7402
Add a docstring for TreeNode.__init__
2023-03-01 13:26:27 +00:00
Dave Pearson
dbb52637c5
Document NodeID
...
It's in the public interface for tree, so it should be documented.
2023-03-01 13:23:28 +00:00
Dave Pearson
ac35c1d1d5
Document TreeNode via Tree itself
...
There's a couple of other types in the public interface of Tree that should
be teased out, and it feels odd to have one type in one file and a bunch of
others in another. So this sets us up for having them all the same place.
This should make it easier for the reader to find related information.
2023-03-01 13:21:45 +00:00
Dave Pearson
a837cd1d85
Ensure PlaceholderVariant gets included in the docs
2023-03-01 13:08:40 +00:00
Dave Pearson
e21e55200d
Add a module docstring to _tree.py
2023-03-01 12:59:19 +00:00
Dave Pearson
662c1d8f7d
Add a missing
2023-03-01 12:56:28 +00:00