Skip to content

Commit 97cdfa0

Browse files
committed
style: update comments for clarity and improve code readability in doc_ast.ex and templates.ex
1 parent 9770ce7 commit 97cdfa0

File tree

2 files changed

+4
-5
lines changed

2 files changed

+4
-5
lines changed

lib/ex_doc/doc_ast.ex

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -114,7 +114,7 @@ defmodule ExDoc.DocAST do
114114
"![#{alt}](#{attrs[:src]} \"#{title}\")"
115115
end
116116

117-
# ignoring these: area base col command embed input keygen link meta param source track wbr
117+
# Ignoring these: area base col command embed input keygen link meta param source track wbr
118118
def to_markdown({tag, _attrs, _inner, _meta}) when tag in @void_elements do
119119
""
120120
end

lib/ex_doc/formatter/markdown/templates.ex

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -21,9 +21,9 @@ defmodule ExDoc.Formatter.MARKDOWN.Templates do
2121
@doc """
2222
Returns the formatted title for the module page.
2323
"""
24-
def module_type(%{type: :task}), do: ""
25-
def module_type(%{type: :module}), do: ""
26-
def module_type(%{type: type}), do: "(#{type})"
24+
def module_type(%{type: :task} = _node), do: ""
25+
def module_type(%{type: :module} = _node), do: ""
26+
def module_type(%{type: type} = _node), do: "(#{type})"
2727

2828
@doc """
2929
Format the attribute type used to define the spec of the given `node`.
@@ -196,7 +196,6 @@ defmodule ExDoc.Formatter.MARKDOWN.Templates do
196196

197197
@doc """
198198
Creates the table of contents.
199-
200199
"""
201200
EEx.function_from_file(
202201
:def,

0 commit comments

Comments
 (0)