Skip to content

Commit 1a4d61a

Browse files
authored
revert: how it works documentation (#89)
* Update FluxQueue description * revert: how it works documentation
1 parent e752a26 commit 1a4d61a

4 files changed

Lines changed: 10 additions & 10 deletions

File tree

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
<div align="center">
66

7-
**A lightweight, high-throughput task queue for Python, written in Rust.**
7+
**A lightweight, resource-efficient, high-throughput task queue for Python, written in Rust.**
88

99
![Python versions](https://img.shields.io/badge/python-3.11%20%7C%203.12%20%7C%203.13%20%7C%203.14-green)
1010

@@ -97,7 +97,7 @@ Running the worker is straightforward:
9797
fluxqueue start --tasks-module-path myapp/tasks
9898
```
9999

100-
In order the worker to disover your tasks you need to pass `--tasks-module-path` argument with the path to the tasks module. For more information please view the [Defining and Exposing Tasks](https://fluxqueue.ccxlv.dev/tutorial/defininig_and_exposing_tasks) documentation.
100+
In order the worker to disover your tasks you need to pass `--tasks-module-path` argument with the path to the tasks module. For more information please view the [defining and exposing tasks](https://fluxqueue.ccxlv.dev/tutorial/defininig_and_exposing_tasks) documentation.
101101

102102
## License
103103

crates/fluxqueue-worker/src/worker.rs

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,6 @@ pub async fn run_worker(
5050

5151
let queue_name = Arc::from(queue_name.to_string());
5252
let executor_ids = generate_executor_ids(concurrency);
53-
let python_dispatcher = Arc::new(PythonDispatcher::new());
5453
let mut executors = JoinSet::new();
5554

5655
for i in 0..concurrency {
@@ -59,7 +58,7 @@ pub async fn run_worker(
5958
let executor_id = Arc::clone(&executor_ids[i]);
6059
let shutdown = shutdown.clone();
6160
let task_registry = Arc::clone(&task_registry);
62-
let python_dispatcher = Arc::clone(&python_dispatcher);
61+
let python_dispatcher = Arc::new(PythonDispatcher::new());
6362

6463
redis_client
6564
.register_executor(&queue_name, &executor_id)

docs/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,15 +5,15 @@
55
<img src="images/logo_full.png" alt="FluxQueue" />
66
</p>
77

8-
Welcome to FluxQueue documentation. FluxQueue is lightweight, high-throughput task queue for Python, written in Rust.
8+
Welcome to FluxQueue documentation. FluxQueue is a lightweight, resource-efficient, high-throughput task queue for Python, written in Rust.
99

1010
## Quick Links
1111

1212
- [Installation](tutorial/installation.md) - Get started with FluxQueue
1313
- [Quick Start](tutorial/quickstart.md) - Your first task queue
1414
- [Defining and Exposing Tasks](tutorial/defininig_and_exposing_tasks.md) - Organize and expose tasks for the worker
1515
- [Worker Setup](tutorial/worker.md) - Deploy and run workers
16-
- [How it Works](how-it-works/index.md) - Learn more about how FluxQueue actually works
16+
<!--- [How it Works](how-it-works/index.md) - Learn more about how FluxQueue actually works-->
1717
- [API Reference](api/index.md) - Complete API documentation
1818

1919
## What is FluxQueue?

mkdocs.yml

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
site_name: FluxQueue
2+
site_description: A lightweight, resource-efficient, high-throughput task queue for Python, written in Rust.
23

34
theme:
45
name: material
@@ -65,10 +66,10 @@ nav:
6566
- tutorial/quickstart.md
6667
- tutorial/defininig_and_exposing_tasks.md
6768
- tutorial/worker.md
68-
- How it Works:
69-
- how-it-works/index.md
70-
- how-it-works/client.md
71-
- how-it-works/worker.md
69+
# - How it Works:
70+
# - how-it-works/index.md
71+
# - how-it-works/client.md
72+
# - how-it-works/worker.md
7273
- API Reference:
7374
- api/index.md
7475
- api/fluxqueue.md

0 commit comments

Comments
 (0)