aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorAdrian Herrmann <adrian.herrmann@qt.io>2022-11-10 12:12:46 +0100
committerQt Cherry-pick Bot <cherrypick_bot@qt-project.org>2022-11-10 13:15:04 +0000
commit6a90d7206916ee3ab3608e66fdf5c85516078458 (patch)
tree597e1657512def381cbf99ff5605d410273868bb
parentf97461f7440add879ebdc0d57c4fd1e3f41d48a4 (diff)
async: Fix formatting in rst documentation
Indentations were wrong. Task-number: PYSIDE-769 Change-Id: If021423787959d940e92cbc75624430adf5d03ce Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io> (cherry picked from commit 2a71960d3ff3640b3dcb0c1b1eb004bbb3eaea4d) Reviewed-by: Qt Cherry-pick Bot <cherrypick_bot@qt-project.org>
-rw-r--r--examples/async/eratosthenes/doc/eratosthenes.rst16
-rw-r--r--examples/async/minimal/doc/minimal.rst16
2 files changed, 16 insertions, 16 deletions
diff --git a/examples/async/eratosthenes/doc/eratosthenes.rst b/examples/async/eratosthenes/doc/eratosthenes.rst
index 37758e99f..fdb095a91 100644
--- a/examples/async/eratosthenes/doc/eratosthenes.rst
+++ b/examples/async/eratosthenes/doc/eratosthenes.rst
@@ -22,20 +22,20 @@ implemented: `eratosthenes` and `minimal`:
:width: 400
* `eratosthenes` is a more extensive example that visualizes the Sieve of
-Eratosthenes algorithm. This algorithm per se is not one that is particularly
-suitable for asynchronous operations as it's not I/O-heavy, but synchronizing
-coroutines to a configurable tick allows for a good visualization.
+ Eratosthenes algorithm. This algorithm per se is not one that is particularly
+ suitable for asynchronous operations as it's not I/O-heavy, but synchronizing
+ coroutines to a configurable tick allows for a good visualization.
* `minimal` is a minimal example featuring a button that triggers an
-asynchronous coroutine with a sleep. It is designed to highlight which
-boilerplate code is essential for an async program with Qt and offers a
-starting point for more complex programs.
+ asynchronous coroutine with a sleep. It is designed to highlight which
+ boilerplate code is essential for an async program with Qt and offers a
+ starting point for more complex programs.
Both examples feature:
1. A window class.
2. An `AsyncHelper` class containing `start_guest_run` plus helpers and
-callbacks necessary for its invocation. The entry point for the Trio guest run
-is provided as an argument from outside, which can be any async function.
+ callbacks necessary for its invocation. The entry point for the Trio guest
+ run is provided as an argument from outside, which can be any async function.
While `eratosthenes` offloads the asynchronous logic that will run in trio's
event loop into a separate class, `minimal` demonstrates that async functions
diff --git a/examples/async/minimal/doc/minimal.rst b/examples/async/minimal/doc/minimal.rst
index a72e8a73c..dcab2fe29 100644
--- a/examples/async/minimal/doc/minimal.rst
+++ b/examples/async/minimal/doc/minimal.rst
@@ -21,20 +21,20 @@ implemented: `eratosthenes` and `minimal`:
:alt: Async example: Minimal
* `eratosthenes` is a more extensive example that visualizes the Sieve of
-Eratosthenes algorithm. This algorithm per se is not one that is particularly
-suitable for asynchronous operations as it's not I/O-heavy, but synchronizing
-coroutines to a configurable tick allows for a good visualization.
+ Eratosthenes algorithm. This algorithm per se is not one that is particularly
+ suitable for asynchronous operations as it's not I/O-heavy, but synchronizing
+ coroutines to a configurable tick allows for a good visualization.
* `minimal` is a minimal example featuring a button that triggers an
-asynchronous coroutine with a sleep. It is designed to highlight which
-boilerplate code is essential for an async program with Qt and offers a
-starting point for more complex programs.
+ asynchronous coroutine with a sleep. It is designed to highlight which
+ boilerplate code is essential for an async program with Qt and offers a
+ starting point for more complex programs.
Both examples feature:
1. A window class.
2. An `AsyncHelper` class containing `start_guest_run` plus helpers and
-callbacks necessary for its invocation. The entry point for the Trio guest run
-is provided as an argument from outside, which can be any async function.
+ callbacks necessary for its invocation. The entry point for the Trio guest
+ run is provided as an argument from outside, which can be any async function.
While `eratosthenes` offloads the asynchronous logic that will run in trio's
event loop into a separate class, `minimal` demonstrates that async functions