Merge pull request #1898 from davep/extend-api-docs-linkage

Increase the coverage of API documentation
This commit is contained in:
Dave Pearson
2023-02-28 16:18:24 +00:00
committed by GitHub
11 changed files with 15 additions and 9 deletions

1
docs/api/await_remove.md Normal file
View File

@@ -0,0 +1 @@
::: textual.await_remove

View File

@@ -1 +1 @@
::: textual.binding.Binding
::: textual.binding

View File

@@ -1 +1 @@
::: textual.coordinate.Coordinate
::: textual.coordinate

View File

@@ -1 +1 @@
::: textual.dom.DOMNode
::: textual.dom

View File

@@ -1 +1 @@
::: textual.message.Message
::: textual.message

View File

@@ -2,4 +2,4 @@ A message pump is a class that processes messages.
It is a base class for the `App`, `Screen`, and `Widget` classes.
::: textual.message_pump.MessagePump
::: textual.message_pump

View File

@@ -1 +1 @@
::: textual.scroll_view.ScrollView
::: textual.scroll_view

View File

@@ -1 +1 @@
::: textual.strip.Strip
::: textual.strip

View File

@@ -1 +1 @@
::: textual.widget.Widget
::: textual.widget

View File

@@ -142,6 +142,7 @@ nav:
- "widgets/tree.md"
- API:
- "api/app.md"
- "api/await_remove.md"
- "api/binding.md"
- "api/button.md"
- "api/checkbox.md"

View File

@@ -5,7 +5,11 @@ from typing import Generator
class AwaitRemove:
"""An awaitable returned by App.remove and DOMQuery.remove."""
"""An awaitable returned by a method that removes DOM nodes.
Returned by [Widget.remove][textual.widget.Widget.remove] and
[DOMQuery.remove][textual.css.query.DOMQuery.remove].
"""
def __init__(self, finished_flag: Event, task: Task) -> None:
"""Initialise the instance of ``AwaitRemove``.