Skip to content

Commit 6eaa56d

Browse files
authored
Fix typos and command in docs (#134)
1 parent e67dab3 commit 6eaa56d

28 files changed

+43
-43
lines changed

docs/available-components/brokers.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ In this section we'll list officially supported brokers.
1010

1111
This is a special broker for local development. It uses the same functions to execute tasks,
1212
but all tasks are executed locally in the current thread.
13-
By default it uses `InMemoryResultBackend` but this can be overriden.
13+
By default it uses `InMemoryResultBackend` but this can be overridden.
1414

1515
## ZeroMQBroker
1616

docs/examples/extending/result_backend.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ async def is_result_ready(
5353
Check if result exists.
5454
5555
This function must check whether result
56-
is available in your resul backend
56+
is available in your result backend
5757
without fetching the result.
5858
5959
:param task_id: id of a task.

docs/guide/architecture-overview.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -119,13 +119,13 @@ test_project
119119
You can specify all tasks modules to import manually.
120120

121121
```bash
122-
taskiq test_project.broker:broker test_projec.submodule.tasks test_projec.utils.tasks
122+
taskiq worker test_project.broker:broker test_project.submodule.tasks test_project.utils.tasks
123123
```
124124

125125
Or you can let taskiq find all python modules named tasks in current directory recursively.
126126

127127
```bash
128-
taskiq test_project.broker:broker -fsd
128+
taskiq worker test_project.broker:broker -fsd
129129
```
130130

131131
If you have uvloop installed, taskiq will automatically install new policies to event loop.

docs/guide/scheduling-tasks.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ Of course we can implement loop like this:
2222
await asyncio.sleep(timedelta(minutes=5).total_seconds)
2323
```
2424

25-
But if you have many schedules it may be a little painful to implement. So let me introuce you the `TaskiqScheduler`.
25+
But if you have many schedules it may be a little painful to implement. So let me introduce you the `TaskiqScheduler`.
2626
Let's add scheduler to our module.
2727

2828
@[code python](../examples/schedule/intro.py)

docs/guide/state-and-deps.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -102,7 +102,7 @@ For example:
102102

103103
@[code python](../examples/state/dependencies_tree.py)
104104

105-
In this code, the dependency `common_dep` is going to be evaluated only once and the `dep1` and the `dep2` are going to recevie the same value. You can control this behavior by using the `use_cache=False` parameter to you dependency. This parameter will force the
105+
In this code, the dependency `common_dep` is going to be evaluated only once and the `dep1` and the `dep2` are going to receive the same value. You can control this behavior by using the `use_cache=False` parameter to you dependency. This parameter will force the
106106
dependency to reevaluate all it's subdependencies.
107107

108108
In this example we cannot predict the result. Since the `dep2` doesn't use cache for the `common_dep` function.
@@ -167,7 +167,7 @@ If you want to do something asynchronously, convert this function to an asynchro
167167

168168
### Default dependencies
169169

170-
By default taskiq has only two deendencies:
170+
By default taskiq has only two dependencies:
171171

172172
- Context from `taskiq.context.Context`
173173
- TaskiqState from `taskiq.state.TaskiqState`

docs/guide/taskiq-with-fastapi.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ FastAPI is one of the most popular async web frameworks in python. It has gained
88
1. It's easy to use;
99
2. It has a cool dependency injection.
1010

11-
In taskiq we try to make our libraries easy to use and we too have a depenndency injection. But our dependencies
11+
In taskiq we try to make our libraries easy to use and we too have a dependency injection. But our dependencies
1212
are not compatible with FastAPI's dependencies by default. That is why we have created a library "[taskiq-fastapi](https://pypi.org/project/taskiq-fastapi/)" to make integration with
1313
FastAPI as smooth as possible.
1414

docs/guide/testing-taskiq.md

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

55
# Testing with taskiq
66

7-
Everytime we write programs, we want them to be correct. To achieve this, we use tests.
7+
Every time we write programs, we want them to be correct. To achieve this, we use tests.
88
Taskiq allows you to write tests easily as if tasks were normal functions.
99

1010
Let's dive into examples.
@@ -76,7 +76,7 @@ After the preparations are done, we need to modify the broker's file in your pro
7676

7777
As you can see, we added an `if` statement. If the expression is true, we replace our broker with an imemory broker.
7878
The main point here is to not have an actual connection during testing. It's useful because inmemory broker has
79-
the same interface as a real broker, but it doesn't send tasks acutally.
79+
the same interface as a real broker, but it doesn't send tasks actually.
8080

8181
## Testing tasks
8282

taskiq/abc/broker.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -113,7 +113,7 @@ def add_dependency_context(self, new_ctx: Dict[Any, Any]) -> None:
113113
Provided dict will be used to inject new dependencies
114114
in all dependency graph contexts.
115115
116-
:param new_ctx: Additional context values for dependnecy injection.
116+
:param new_ctx: Additional context values for dependency injection.
117117
"""
118118
self.custom_dependency_context.update(new_ctx)
119119

@@ -152,7 +152,7 @@ async def shutdown(self) -> None:
152152
Close the broker.
153153
154154
This method is called,
155-
when broker is closig.
155+
when broker is closing.
156156
"""
157157
event = TaskiqEvents.CLIENT_SHUTDOWN
158158
if self.is_worker_process:

taskiq/abc/middleware.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ def pre_execute(
5555
"""
5656
This hook is called before executing task.
5757
58-
This is a worker-side hook, wich means it
58+
This is a worker-side hook, which means it
5959
executes in the worker process.
6060
6161
:param message: incoming parsed taskiq message.

taskiq/abc/result_backend.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ async def set_result(self, task_id: str, result: TaskiqResult[_ReturnType]) -> N
2020
"""
2121
Saves result to the result backend.
2222
23-
Result must be save so it can be accesed later
23+
Result must be save so it can be accessed later
2424
by the calling side of the system.
2525
2626
:param task_id: id of a task to save.

0 commit comments

Comments
 (0)