Skip to content

Commit de7e6c0

Browse files
committed
review fixes
1 parent dfd8f71 commit de7e6c0

File tree

5 files changed

+12
-18
lines changed

5 files changed

+12
-18
lines changed

lib/ex_doc/formatter/epub/templates.ex

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,7 @@ defmodule ExDoc.Formatter.EPUB.Templates do
1616
Generate content from the module template for a given `node`
1717
"""
1818
def module_page(config, module_node) do
19-
summary = H.module_summary(module_node)
20-
module_template(config, module_node, summary)
19+
module_template(config, module_node)
2120
end
2221

2322
@doc """
@@ -53,7 +52,7 @@ defmodule ExDoc.Formatter.EPUB.Templates do
5352
:def,
5453
:module_template,
5554
Path.expand("templates/module_template.eex", __DIR__),
56-
[:config, :module, :summary],
55+
[:config, :module],
5756
trim: true
5857
)
5958

lib/ex_doc/formatter/epub/templates/module_template.eex

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,14 +15,14 @@
1515
</section>
1616
<% end %>
1717

18-
<%= if summary != [] do %>
18+
<%= if module.docs_groups != [] do %>
1919
<section id="summary" class="details-list">
2020
<h1 class="section-heading">Summary</h1>
21-
<%= for group <- summary, do: H.summary_template(group.title, group.docs) %>
21+
<%= for group <- module.docs_groups, do: H.summary_template(group.title, group.docs) %>
2222
</section>
2323
<% end %>
2424

25-
<%= for group <- summary, key = text_to_id(group.title) do %>
25+
<%= for group <- module.docs_groups, key = text_to_id(group.title) do %>
2626
<section id="<%= key %>" class="details-list">
2727
<h1 class="section-heading"><%=h to_string(group.title) %></h1>
2828
<%= if doc = group.doc do %>

lib/ex_doc/formatter/html/assets.ex

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ defmodule ExDoc.Formatter.HTML.Assets do
77
|> Path.wildcard()
88
|> Enum.map(fn path ->
99
Module.put_attribute(__CALLER__.module, :external_resource, path)
10-
{Path.basename(path), "File.read!(#{path})"}
10+
{Path.basename(path), File.read!(path)}
1111
end)
1212
end
1313

lib/ex_doc/formatter/html/templates.ex

Lines changed: 3 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,7 @@ defmodule ExDoc.Formatter.HTML.Templates do
1616
Generate content from the module template for a given `node`
1717
"""
1818
def module_page(module_node, config) do
19-
summary = module_summary(module_node)
20-
module_template(config, module_node, summary)
19+
module_template(config, module_node)
2120
end
2221

2322
@doc """
@@ -99,9 +98,7 @@ defmodule ExDoc.Formatter.HTML.Templates do
9998
modules =
10099
for module <- modules do
101100
groups =
102-
module
103-
|> module_summary()
104-
|> case do
101+
case module.docs_groups do
105102
[] -> []
106103
entries -> [nodeGroups: Enum.map(entries, &sidebar_entries/1)]
107104
end
@@ -153,8 +150,6 @@ defmodule ExDoc.Formatter.HTML.Templates do
153150
end)
154151
end
155152

156-
def module_summary(module_node), do: module_node.docs_groups
157-
158153
defp favicon_path(%{favicon: nil}), do: nil
159154
defp favicon_path(%{favicon: favicon}), do: "assets/favicon#{Path.extname(favicon)}"
160155

@@ -222,7 +217,7 @@ defmodule ExDoc.Formatter.HTML.Templates do
222217
detail_template: [:node, :module],
223218
footer_template: [:config, :source_path],
224219
head_template: [:config, :title, :noindex],
225-
module_template: [:config, :module, :summary],
220+
module_template: [:config, :module],
226221
not_found_template: [:config],
227222
api_reference_entry_template: [:module_node],
228223
api_reference_template: [:config, :nodes_map],

lib/ex_doc/formatter/html/templates/module_template.eex

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -31,19 +31,19 @@
3131
<% end %>
3232
</div>
3333

34-
<%= if summary != [] do %>
34+
<%= if module.docs_groups != [] do %>
3535
<section id="summary" class="details-list">
3636
<h1 class="section-heading">
3737
<a class="hover-link" href="#summary">
3838
<i class="ri-link-m" aria-hidden="true"></i>
3939
</a>
4040
<span class="text">Summary</span>
4141
</h1>
42-
<%= for group <- summary, do: summary_template(group.title, group.docs) %>
42+
<%= for group <- module.docs_groups, do: summary_template(group.title, group.docs) %>
4343
</section>
4444
<% end %>
4545

46-
<%= for group <- summary, key = text_to_id(group.title) do %>
46+
<%= for group <- module.docs_groups, key = text_to_id(group.title) do %>
4747
<section id="<%= key %>" class="details-list">
4848
<h1 class="section-heading">
4949
<a class="hover-link" href="#<%= key %>">

0 commit comments

Comments
 (0)