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 (148 forks)batch import
help wanted

Repository metrics

Stars
 (1,329 stars)
PR merge metrics
 (No merged PRs in 30d)

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

Research direction
Inspect the comment formatting logic in elm format to identify where underscores are escaped and ensure that comments are excluded from this escaping.
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.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75