diff --git a/src/tqdm_publisher/_demos/_multiple_bars/README.md b/src/tqdm_publisher/_demos/_multiple_bars/README.md index 0992be6..678a0be 100644 --- a/src/tqdm_publisher/_demos/_multiple_bars/README.md +++ b/src/tqdm_publisher/_demos/_multiple_bars/README.md @@ -2,6 +2,6 @@ This demo shows how to use `tqdm_publisher` to forward progress updates from multiple `TQDMPublisher` instances to the browser. ## The Approach -This demo is nearly identical to the [single bar demo](../_single_bar/README.md), except that progress bars are managed through a scoped class definition. +This demo is nearly identical to the [single bar demo](../_single_bar/README.md), except that progress bars are managed through a scoped class definition. -This allows us to easily track a `request_id` passed when the client requests a new progress bar, associating each progress bar with a pre-populated element on the browser. \ No newline at end of file +This allows us to easily track a `request_id` passed when the client requests a new progress bar, associating each progress bar with a pre-populated element on the browser. diff --git a/src/tqdm_publisher/_demos/_parallel_bars/README.md b/src/tqdm_publisher/_demos/_parallel_bars/README.md index d6cb195..336ddd9 100644 --- a/src/tqdm_publisher/_demos/_parallel_bars/README.md +++ b/src/tqdm_publisher/_demos/_parallel_bars/README.md @@ -4,7 +4,7 @@ This demo shows how to use a global `TQDMPublisher` instance to forward progress ## The Approach In this demo, we track multipl, interdependent levels of progress updates by using a global `TQDMPublisher` instance to reflect the execution state of parallel `TQDMPublisher` instances. -Similar to the [multiple bar demo](../_multiple_bars/README.md), a `request_id` is used to associate both the global and parallel progress bars with a specific group of elements on the browser. In particular, the ID of the global progress bar matches the `request_id`, allowing it to be distinguished from the lower-level progress bars. +Similar to the [multiple bar demo](../_multiple_bars/README.md), a `request_id` is used to associate both the global and parallel progress bars with a specific group of elements on the browser. In particular, the ID of the global progress bar matches the `request_id`, allowing it to be distinguished from the lower-level progress bars. However, this approach also differs in many ways from the other demos: 1. Instead of a `websockets` server, we use a `flask` server to receive requests from the client and send updates back using the Server-Sent Events (SSE) protocol. diff --git a/src/tqdm_publisher/_demos/_single_bar/README.md b/src/tqdm_publisher/_demos/_single_bar/README.md index 3233923..2d1e045 100644 --- a/src/tqdm_publisher/_demos/_single_bar/README.md +++ b/src/tqdm_publisher/_demos/_single_bar/README.md @@ -2,9 +2,8 @@ This demo shows how to use `tqdm_publisher` to forward progress updates from a single `TQDMPublisher` instance to the browser. ## The Approach -We use `websockets` to establish a connection between the server and the client. +We use `websockets` to establish a connection between the server and the client. -A progress bar is pre-rendered on page load. When the client presses the Create Progress Bar button, the server forwards progress updates to the client using a `TQDMPublisher` instance spawned in a separate thread. +A progress bar is pre-rendered on page load. When the client presses the Create Progress Bar button, the server forwards progress updates to the client using a `TQDMPublisher` instance spawned in a separate thread. The Create button is disabled until the progress bar is finished to avoid associating updates from multiple progress bars with their respective elements. -