avh4/elm-format

Backslash prepended to underscores in comments

Open

#587 opened on Dec 24, 2018

View on GitHub
 (2 comments) (0 reactions) (0 assignees)Haskell (1,329 stars) (148 forks)batch import
help wanted

Description

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.

Contributor guide

Tech stack
None
Domain
tooling
Issue type
bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
None
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75
Research direction
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.
Backslash prepended to underscores in comments · avh4/elm-format#587 | Good First Issue