Skip to content

Fix mix task documentation typos #568

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion lib/mix/tasks/ash_postgres.drop.ex
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ defmodule Mix.Tasks.AshPostgres.Drop do
* `--force-drop` - force the database to be dropped even
if it has connections to it (requires PostgreSQL 13+)
* `--no-compile` - do not compile before dropping
* `--no-deps-check` - do not compile before dropping
* `--no-deps-check` - do not check dependencies before dropping
"""

@doc false
Expand Down
4 changes: 2 additions & 2 deletions lib/mix/tasks/ash_postgres.gen.resources.ex
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ if Code.ensure_loaded?(Igniter) do
defmodule Mix.Tasks.AshPostgres.Gen.Resources do
use Igniter.Mix.Task

@example "mix ash_postgres.gen.resource MyApp.MyDomain"
@example "mix ash_postgres.gen.resources MyApp.MyDomain"

@shortdoc "Generates resources based on a database schema"

Expand All @@ -23,7 +23,7 @@ if Code.ensure_loaded?(Igniter) do
- `repo`, `r` - The repo or repos to generate resources for, comma separated. Can be specified multiple times. Defaults to all repos.
- `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.
- `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.
- `snapshots-only` - Only generate snapshots for the generated resources, and not migraitons.
- `snapshots-only` - Only generate snapshots for the generated resources, and not migrations.
- `extend`, `e` - Extension or extensions to apply to the generated resources. See `mix ash.patch.extend` for more.
- `yes`, `y` - Answer yes (or skip) to all questions.
- `default-actions` - Add default actions for each resource. Defaults to `true`.
Expand Down
2 changes: 1 addition & 1 deletion lib/mix/tasks/ash_postgres.generate_migrations.ex
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ defmodule Mix.Tasks.AshPostgres.GenerateMigrations do

Generally speaking, it is bad practice to drop columns when you deploy a change that
would remove an attribute. The main reasons for this are backwards compatibility and rolling restarts.
If you deploy an attribute removal, and run migrations. Regardless of your deployment sstrategy, you
If you deploy an attribute removal, and run migrations. Regardless of your deployment strategy, you
won't be able to roll back, because the data has been deleted. In a rolling restart situation, some of
the machines/pods/whatever may still be running after the column has been deleted, causing errors. With
this in mind, its best not to delete those columns until later, after the data has been confirmed unnecessary.
Expand Down
4 changes: 2 additions & 2 deletions lib/mix/tasks/ash_postgres.migrate.ex
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ defmodule Mix.Tasks.AshPostgres.Migrate do
import AshPostgres.Mix.Helpers,
only: [migrations_path: 2, tenant_migrations_path: 2, tenants: 2]

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

@aliases [
n: :step,
Expand Down Expand Up @@ -95,7 +95,7 @@ defmodule Mix.Tasks.AshPostgres.Migrate do

* `--no-compile` - does not compile applications before migrating

* `--no-deps-check` - does not check depedendencies before migrating
* `--no-deps-check` - does not check dependencies before migrating

* `--migrations-path` - the path to load the migrations from, defaults to
`"priv/repo/migrations"`. This option may be given multiple times in which case the migrations
Expand Down
2 changes: 1 addition & 1 deletion lib/mix/tasks/ash_postgres.rollback.ex
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ defmodule Mix.Tasks.AshPostgres.Rollback do
mix ash_postgres.rollback --to 20080906120000

## Command line options
* `--domains` - the domains who's repos should be rolledback
* `--domains` - the domains whose repos should be rolled back
* `--all` - revert all applied migrations
* `--repo`, `-r` - the repo to rollback
* `--step` / `-n` - revert n number of applied migrations
Expand Down
2 changes: 1 addition & 1 deletion lib/mix/tasks/ash_postgres.squash_snapshots.ex
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ defmodule Mix.Tasks.AshPostgres.SquashSnapshots do
a remaining snapshot. `last` keeps the name of the last snapshot, `first` renames it to the previously first,
`zero` sets name with fourteen zeros.
* `--snapshot-path` - a custom path to stored snapshots. The default is "priv/resource_snapshots".
* `--quiet` - no messages will not be printed.
* `--quiet` - no messages will be printed.
* `--dry-run` - no files are touched, instead prints folders that have snapshots to squash.
* `--check` - no files are touched, instead returns an exit(1) code if there are snapshots to squash.
"""
Expand Down