comment the @format pragma to avoid edoc warnings #281
Conversation
facebook-github-bot
added
the
CLA Signed
src/erlfmt.erl
Outdated
| [{comment, #{location => Loc, end_location => Loc}, ["%%% % @format", ""]}]; | ||
| _ -> | ||
| {comment, Loc, LastComments} = lists:last(PreComments), | ||
| lists:droplast(PreComments) ++ | ||
| [{comment, Loc, LastComments ++ ["%% @format"]}] | ||
| [{comment, Loc, LastComments ++ ["%%% % @format"]}] |
There was a problem hiding this comment.
I feel like the proper way to do this would be to detect whether to use %% or %%%, In particular something like:
{Prefix, _} = string:take(lists:last(LastComments), "%"),
[{comment, Loc, LastComments ++ [Prefix ++ " % @format"]}]I don't have a preference for what should be the default in case there weren't any comments already.
There was a problem hiding this comment.
We could, but we still need a default for the case where there are no comments yet and in this case I think we should do 3 comments, given this new analyses: #283
There was a problem hiding this comment.
I have added your suggestion :)
src/erlfmt.erl
Outdated
| replace_pragma_comment_block([]) -> | ||
| []; | ||
| replace_pragma_comment_block(["%% @format" | Tail]) -> | ||
| ["%%% % @format" | Tail]; | ||
| replace_pragma_comment_block([Head | Tail]) -> | ||
| [Head | replace_pragma_comment_block(Tail)]. |
There was a problem hiding this comment.
I'm not convinced about forcing the triple comment. What if the surrounding comment uses only double? It would be strange to end up with something like:
%% Some licence info
%%
%%% % @format
%%
%% @doc ....e.g. where this would happen: https://github.com/erlang/otp/blob/master/lib/edoc/src/edoc.erl
There was a problem hiding this comment.
Yes we could replace it with the number of percentages that was there.
There was a problem hiding this comment.
I have also addressed this with a default of 3, but if some other number is detected we prefer that.
src/erlfmt.erl
Outdated
| [] -> | ||
| replace_pragma_comment_block(Prefix, Rest); |
There was a problem hiding this comment.
Can this happen? I don't think we ever produce empty comment blocks and replace_pragma_comment_block/2 never drops any list elements
There was a problem hiding this comment.
Good catch, I updated the code.
Fixes #277
Some context: Marc-Andre has shown me an analyses of triple comments that removes the bias in my analyses, that shows that they are actually popular in erlang before the module attribute. We will work on pushing this analyses to the repo, but I think we should adopt this style in insert pragma