Skip to content

Commit aff1c41

Browse files
docs: Fix mix task documentation typos (#568)
1 parent fd2b80d commit aff1c41

6 files changed

+8
-8
lines changed

lib/mix/tasks/ash_postgres.drop.ex

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ defmodule Mix.Tasks.AshPostgres.Drop do
3939
* `--force-drop` - force the database to be dropped even
4040
if it has connections to it (requires PostgreSQL 13+)
4141
* `--no-compile` - do not compile before dropping
42-
* `--no-deps-check` - do not compile before dropping
42+
* `--no-deps-check` - do not check dependencies before dropping
4343
"""
4444

4545
@doc false

lib/mix/tasks/ash_postgres.gen.resources.ex

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ if Code.ensure_loaded?(Igniter) do
22
defmodule Mix.Tasks.AshPostgres.Gen.Resources do
33
use Igniter.Mix.Task
44

5-
@example "mix ash_postgres.gen.resource MyApp.MyDomain"
5+
@example "mix ash_postgres.gen.resources MyApp.MyDomain"
66

77
@shortdoc "Generates resources based on a database schema"
88

@@ -23,7 +23,7 @@ if Code.ensure_loaded?(Igniter) do
2323
- `repo`, `r` - The repo or repos to generate resources for, comma separated. Can be specified multiple times. Defaults to all repos.
2424
- `tables`, `t` - Defaults to `public.*`. The tables to generate resources for, comma separated. Can be specified multiple times. See the section on tables for more.
2525
- `skip-tables`, `s` - The tables to skip generating resources for, comma separated. Can be specified multiple times. See the section on tables for more. `schema_migrations` is always skipped.
26-
- `snapshots-only` - Only generate snapshots for the generated resources, and not migraitons.
26+
- `snapshots-only` - Only generate snapshots for the generated resources, and not migrations.
2727
- `extend`, `e` - Extension or extensions to apply to the generated resources. See `mix ash.patch.extend` for more.
2828
- `yes`, `y` - Answer yes (or skip) to all questions.
2929
- `default-actions` - Add default actions for each resource. Defaults to `true`.

lib/mix/tasks/ash_postgres.generate_migrations.ex

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ defmodule Mix.Tasks.AshPostgres.GenerateMigrations do
3737
3838
Generally speaking, it is bad practice to drop columns when you deploy a change that
3939
would remove an attribute. The main reasons for this are backwards compatibility and rolling restarts.
40-
If you deploy an attribute removal, and run migrations. Regardless of your deployment sstrategy, you
40+
If you deploy an attribute removal, and run migrations. Regardless of your deployment strategy, you
4141
won't be able to roll back, because the data has been deleted. In a rolling restart situation, some of
4242
the machines/pods/whatever may still be running after the column has been deleted, causing errors. With
4343
this in mind, its best not to delete those columns until later, after the data has been confirmed unnecessary.

lib/mix/tasks/ash_postgres.migrate.ex

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ defmodule Mix.Tasks.AshPostgres.Migrate do
44
import AshPostgres.Mix.Helpers,
55
only: [migrations_path: 2, tenant_migrations_path: 2, tenants: 2]
66

7-
@shortdoc "Runs the repository migrations for all repositories in the provided (or congigured) domains"
7+
@shortdoc "Runs the repository migrations for all repositories in the provided (or configured) domains"
88

99
@aliases [
1010
n: :step,
@@ -95,7 +95,7 @@ defmodule Mix.Tasks.AshPostgres.Migrate do
9595
9696
* `--no-compile` - does not compile applications before migrating
9797
98-
* `--no-deps-check` - does not check depedendencies before migrating
98+
* `--no-deps-check` - does not check dependencies before migrating
9999
100100
* `--migrations-path` - the path to load the migrations from, defaults to
101101
`"priv/repo/migrations"`. This option may be given multiple times in which case the migrations

lib/mix/tasks/ash_postgres.rollback.ex

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ defmodule Mix.Tasks.AshPostgres.Rollback do
3030
mix ash_postgres.rollback --to 20080906120000
3131
3232
## Command line options
33-
* `--domains` - the domains who's repos should be rolledback
33+
* `--domains` - the domains whose repos should be rolled back
3434
* `--all` - revert all applied migrations
3535
* `--repo`, `-r` - the repo to rollback
3636
* `--step` / `-n` - revert n number of applied migrations

lib/mix/tasks/ash_postgres.squash_snapshots.ex

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ defmodule Mix.Tasks.AshPostgres.SquashSnapshots do
2828
a remaining snapshot. `last` keeps the name of the last snapshot, `first` renames it to the previously first,
2929
`zero` sets name with fourteen zeros.
3030
* `--snapshot-path` - a custom path to stored snapshots. The default is "priv/resource_snapshots".
31-
* `--quiet` - no messages will not be printed.
31+
* `--quiet` - no messages will be printed.
3232
* `--dry-run` - no files are touched, instead prints folders that have snapshots to squash.
3333
* `--check` - no files are touched, instead returns an exit(1) code if there are snapshots to squash.
3434
"""

0 commit comments

Comments
 (0)