avh4/elm-format

Backslash prepended to underscores in comments

Open

#587 创建于 2018年12月24日

在 GitHub 查看
 (2 评论) (0 反应) (0 负责人)Haskell (1,329 star) (148 fork)batch import
help wanted

描述

I have a type alias definition in the following form:

{-| represents a diary, as returned by the endpoint api/get_diary.
 -}

type alias Diary =
     { notes : String
     , pages : Int     
     }

Elm-format converts the comment to the following:

{-| represents a diary, as returned by the endpoint api/get\_diary.
 -}

I understand the usefulness of such rule in the code - but it should be ignored in comments.

贡献者指南

技术栈
无
领域
tooling
议题类型
bug
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
2
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
under 1 hour
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
stale
清晰度议题是否清楚说明期望改动、验收标准和下一步。
clear
前置要求
无
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
75
研究方向
Investigate the lexer or formatting rules in elm format's source code, particularly the part that handles comment formatting. The issue is about unwanted backslash escaping of underscores inside comments. Look for logic that processes underscores and ensure it is not applied within comments. Examine existing tests for comment formatting to understand expected behavior.