mirror of
https://github.com/Textualize/textual.git
synced 2025-10-17 02:38:12 +03:00
Merge pull request #1898 from davep/extend-api-docs-linkage
Increase the coverage of API documentation
This commit is contained in:
1
docs/api/await_remove.md
Normal file
1
docs/api/await_remove.md
Normal file
@@ -0,0 +1 @@
|
||||
::: textual.await_remove
|
||||
@@ -1 +1 @@
|
||||
::: textual.binding.Binding
|
||||
::: textual.binding
|
||||
|
||||
@@ -1 +1 @@
|
||||
::: textual.coordinate.Coordinate
|
||||
::: textual.coordinate
|
||||
|
||||
@@ -1 +1 @@
|
||||
::: textual.dom.DOMNode
|
||||
::: textual.dom
|
||||
|
||||
@@ -1 +1 @@
|
||||
::: textual.message.Message
|
||||
::: textual.message
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -1 +1 @@
|
||||
::: textual.scroll_view.ScrollView
|
||||
::: textual.scroll_view
|
||||
|
||||
@@ -1 +1 @@
|
||||
::: textual.strip.Strip
|
||||
::: textual.strip
|
||||
|
||||
@@ -1 +1 @@
|
||||
::: textual.widget.Widget
|
||||
::: textual.widget
|
||||
|
||||
@@ -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"
|
||||
|
||||
@@ -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``.
|
||||
|
||||
Reference in New Issue
Block a user