Skip to content

Commit 84fff0c

Browse files
committed
Add descriptions to Ecto.Repo API groups
1 parent ef7f1f9 commit 84fff0c

File tree

2 files changed

+18
-10
lines changed

2 files changed

+18
-10
lines changed

lib/ecto/repo.ex

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -214,6 +214,24 @@ defmodule Ecto.Repo do
214214
215215
"""
216216

217+
@moduledoc groups: [
218+
%{title: "Query API", description: "Functions that operate on an `Ecto.Query`."},
219+
%{
220+
title: "Schema API",
221+
description: "Functions that operate on an `Ecto.Schema` or a `Ecto.Changeset`."
222+
},
223+
%{
224+
title: "Transaction API",
225+
description: "Functions to work with database transactions and connections."
226+
},
227+
%{
228+
title: "Process API",
229+
description: "Functions to work with repository processes."
230+
},
231+
"Config API",
232+
"User callbacks"
233+
]
234+
217235
@type t :: module
218236

219237
@doc """

mix.exs

Lines changed: 0 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -63,14 +63,6 @@ defmodule Ecto.MixProject do
6363
skip_undefined_reference_warnings_on: ["CHANGELOG.md"],
6464
extras: extras(),
6565
groups_for_extras: groups_for_extras(),
66-
groups_for_docs: [
67-
group_for_function("Query API"),
68-
group_for_function("Schema API"),
69-
group_for_function("Transaction API"),
70-
group_for_function("Process API"),
71-
group_for_function("Config API"),
72-
group_for_function("User callbacks")
73-
],
7466
groups_for_modules: [
7567
# Ecto,
7668
# Ecto.Changeset,
@@ -165,8 +157,6 @@ defmodule Ecto.MixProject do
165157
]
166158
end
167159

168-
defp group_for_function(group), do: {String.to_atom(group), &(&1[:group] == group)}
169-
170160
defp groups_for_extras do
171161
[
172162
Introduction: ~r/guides\/introduction\/.?/,

0 commit comments

Comments
 (0)