Skip to content

Commit

Permalink
Fix typos and improve language (#1123)
Browse files Browse the repository at this point in the history
* Fix typos and improve language
  • Loading branch information
preciz authored Jul 27, 2024
1 parent 3fc4dd0 commit 52be0ff
Show file tree
Hide file tree
Showing 9 changed files with 10 additions and 9 deletions.
2 changes: 1 addition & 1 deletion guides/upgrading/v2.0.md
Original file line number Diff line number Diff line change
Expand Up @@ -155,7 +155,7 @@ Telemetry event names have changed, along with some of the metadata and timing
units. The new event names are consistent and align with the now-standard
`telemetry:span` conventions.

Update handlers to and match on the new event names:
Update handlers to match on the new event names:

```diff
- def handle_event([:oban, :failure], measure, meta, _) do
Expand Down
2 changes: 1 addition & 1 deletion guides/upgrading/v2.11.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ To get started, create a migration to create the table:
$ mix ecto.gen.migration create_oban_peers
```

With in the generated migration module:
Within the generated migration module:

```elixir
use Ecto.Migration
Expand Down
2 changes: 1 addition & 1 deletion lib/oban.ex
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ defmodule Oban do
> #### Oban Web+Pro {: .tip}
>
> A web dashboard for managing Oban, along with an official set of extensions, plugins, and
> workers that expand what Oban is capable are available as licensed packages:
> workers that expand what Oban is capable of are available as licensed packages:
>
> * [🧭 Oban Web](https://getoban.pro#oban-web)
> * [🌟 Oban Pro](https://getoban.pro#oban-pro)
Expand Down
2 changes: 1 addition & 1 deletion lib/oban/engines/inline.ex
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
defmodule Oban.Engines.Inline do
@moduledoc """
A testing-specific engine that's used when Oban's started with `testing: :inline`.
A testing-specific engine that's used when Oban is started with `testing: :inline`.
## Usage
Expand Down
2 changes: 1 addition & 1 deletion lib/oban/plugins/pruner.ex
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ defmodule Oban.Plugins.Pruner do
> #### 🌟 DynamicPruner {: .info}
>
> This plugin limited to a fixed interval and a single `max_age` check for all jobs. To prune
> This plugin is limited to a fixed interval and a single `max_age` check for all jobs. To prune
> on a cron-style schedule, retain jobs by a limit or age, or provide overrides for specific
> queues, workers, and job states; see Oban Pro's
> [DynamicPruner](https://getoban.pro/docs/pro/Oban.Pro.Plugins.DynamicPruner.html).
Expand Down
2 changes: 1 addition & 1 deletion lib/oban/plugins/reindexer.ex
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ defmodule Oban.Plugins.Reindexer do
The plugin uses `REINDEX` with the `CONCURRENTLY` option to rebuild without taking any locks
that prevent concurrent inserts, updates, or deletes on the table.
Note: This plugin requires the `CONCURRENT` option, which is only available in Postgres 12 and
Note: This plugin requires the `CONCURRENTLY` option, which is only available in Postgres 12 and
above.
## Using the Plugin
Expand Down
3 changes: 2 additions & 1 deletion lib/oban/validation.ex
Original file line number Diff line number Diff line change
Expand Up @@ -112,7 +112,8 @@ defmodule Oban.Validation do
if val in list do
:ok
else
{:error, "expected #{inspect(key)} to included in #{inspect(list)}, got: #{inspect(val)}"}
{:error,
"expected #{inspect(key)} to be included in #{inspect(list)}, got: #{inspect(val)}"}
end
end

Expand Down
2 changes: 1 addition & 1 deletion test/oban/peers/global_test.exs
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ defmodule Oban.Peers.GlobalTest do
end)
end

test "emitting elemetry events for elections" do
test "emitting telemetry events for elections" do
TelemetryHandler.attach_events()

start_supervised_oban!(peer: Global, node: "worker.1")
Expand Down
2 changes: 1 addition & 1 deletion test/oban/peers/postgres_test.exs
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ defmodule Oban.Peers.PostgresTest do
assert_received {:event, [:election, :stop], _measure, %{leader: _, peer: Postgres}}
end

test "gacefully handling a missing oban_peers table" do
test "gracefully handling a missing oban_peers table" do
mangle_peers_table!()

logged =
Expand Down

0 comments on commit 52be0ff

Please sign in to comment.