Skip to content

Commit 7bef2cf

Browse files
authored
Mention comment in the docs for functions that take this option (#376)
1 parent 66463eb commit 7bef2cf

1 file changed

Lines changed: 5 additions & 0 deletions

File tree

lib/ecto/migration.ex

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -648,6 +648,7 @@ defmodule Ecto.Migration do
648648
* `:prefix` - the prefix for the table. This prefix will automatically be used
649649
for all constraints and references defined for this table unless explicitly
650650
overridden in said constraints/references.
651+
* `:comment` - adds a comment to the table.
651652
* `:options` - provide custom options that will be appended after the generated
652653
statement. For example, "WITH", "INHERITS", or "ON COMMIT" clauses.
653654
@@ -682,6 +683,7 @@ defmodule Ecto.Migration do
682683
* `:include` - specify fields for a covering index. This is not supported
683684
by all databases. For more information on PostgreSQL support, please
684685
[read the official docs](https://www.postgresql.org/docs/current/indexes-index-only-scans.html).
686+
* `:comment` - adds a comment to the index.
685687
686688
## Adding/dropping indexes concurrently
687689
@@ -926,6 +928,7 @@ defmodule Ecto.Migration do
926928
* `:precision` - the precision for a numeric type. Required when `:scale` is
927929
specified.
928930
* `:scale` - the scale of a numeric type. Defaults to `0`.
931+
* `:comment` - adds a comment to the added column.
929932
* `:after` - positions field after the specified one. Only supported on MySQL,
930933
it is ignored by other databases.
931934
@@ -1061,6 +1064,7 @@ defmodule Ecto.Migration do
10611064
* `:precision` - the precision for a numeric type. Required when `:scale` is
10621065
specified.
10631066
* `:scale` - the scale of a numeric type. Defaults to `0`.
1067+
* `:comment` - adds a comment to the modified column.
10641068
"""
10651069
def modify(column, type, opts \\ []) when is_atom(column) and is_list(opts) do
10661070
validate_precision_opts!(opts, column)
@@ -1215,6 +1219,7 @@ defmodule Ecto.Migration do
12151219
* `:validate` - Whether or not to validate the constraint on creation (true by default). Only
12161220
available in PostgreSQL, and should be followed by a command to validate the new constraint in
12171221
a following migration if false.
1222+
* `:comment` - adds a comment to the constraint.
12181223
12191224
"""
12201225
def constraint(table, name, opts \\ [])

0 commit comments

Comments
 (0)