Skip to content

Commit bd02b83

Browse files
committed
fix: Don't remove double newlines from generated docs
Removing double newlines breaks formatting in e.g. the generated browser docs, and breaks doctests, since they expect the example code sections to be separated by the rest of the comments by double newlines. Fixes: #2433
1 parent 9c580b9 commit bd02b83

File tree

1 file changed

+0
-14
lines changed

1 file changed

+0
-14
lines changed

lib/ash/code_interface.ex

Lines changed: 0 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -465,7 +465,6 @@ defmodule Ash.CodeInterface do
465465
466466
#{interface_options.docs()}
467467
"""
468-
|> Ash.CodeInterface.trim_double_newlines()
469468
@doc spark_opts: [
470469
{opts_location, interface_options.schema()}
471470
]
@@ -531,7 +530,6 @@ defmodule Ash.CodeInterface do
531530
532531
#{interface_options.docs()}
533532
"""
534-
|> Ash.CodeInterface.trim_double_newlines()
535533
@doc spark_opts: [
536534
{opts_location, interface_options.schema()}
537535
]
@@ -1651,7 +1649,6 @@ defmodule Ash.CodeInterface do
16511649
16521650
#{interface_options.docs()}
16531651
"""
1654-
|> Ash.CodeInterface.trim_double_newlines()
16551652

16561653
@doc spark_opts: [
16571654
{first_opts_location, interface_options.schema()},
@@ -1683,7 +1680,6 @@ defmodule Ash.CodeInterface do
16831680
16841681
#{interface_options.docs()}
16851682
"""
1686-
|> Ash.CodeInterface.trim_double_newlines()
16871683

16881684
@doc spark_opts: [
16891685
{first_opts_location, interface_options.schema()},
@@ -1728,7 +1724,6 @@ defmodule Ash.CodeInterface do
17281724
17291725
#{Spark.Options.docs(subject_opts)}
17301726
"""
1731-
|> Ash.CodeInterface.trim_double_newlines()
17321727
@doc spark_opts: [
17331728
{first_opts_location, subject_opts},
17341729
{first_opts_location + 1, subject_opts}
@@ -1754,7 +1749,6 @@ defmodule Ash.CodeInterface do
17541749
17551750
#{Ash.Resource.Interface.CanOpts.docs()}
17561751
"""
1757-
|> Ash.CodeInterface.trim_double_newlines()
17581752
@dialyzer {:nowarn_function, {:"can_#{interface.name}", length(common_args) + 3}}
17591753
@doc spark_opts: [
17601754
{first_opts_location + 1, Ash.Resource.Interface.CanOpts.schema()},
@@ -1842,7 +1836,6 @@ defmodule Ash.CodeInterface do
18421836
18431837
#{Ash.Resource.Interface.CanQuestionMarkOpts.docs()}
18441838
"""
1845-
|> Ash.CodeInterface.trim_double_newlines()
18461839
def unquote(:"can_#{interface.name}?")(
18471840
actor,
18481841
unquote_splicing(common_args),
@@ -2299,13 +2292,6 @@ defmodule Ash.CodeInterface do
22992292
end
23002293
end
23012294

2302-
@doc false
2303-
def trim_double_newlines(str) do
2304-
str
2305-
|> String.replace(~r/\n{2,}/, "\n")
2306-
|> String.trim_trailing()
2307-
end
2308-
23092295
@doc false
23102296
def bulk_query(resource, method, id) do
23112297
case method do

0 commit comments

Comments
 (0)