avh4/elm-format

Backslash prepended to underscores in comments

Open

#587 aberto em 24 de dez. de 2018

Ver no GitHub
 (2 comments) (0 reactions) (0 assignees)Haskell (148 forks)batch import
help wanted

Métricas do repositório

Stars
 (1.329 stars)
Métricas de merge de PR
 (Nenhuma PRs mesclada em 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.

Guia do colaborador

Direção de pesquisa
Investigue o lexer ou as regras de formatação no código fonte do elm format, particularmente a parte que lida com a formatação de comentários. O problema é sobre o escape indesejado com barra invertida de sublinhados dentro de comentários. Procure pela lógica que processa sublinhados e garanta que ela não seja aplicada dentro de comentários. Examine os testes existentes para formatação de comentários para entender o comportamento esperado.
Pilha de tecnologia
None
Domain
tooling
Tipo Issue
Bug
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
2
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
1-3 horas
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Ativo
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
Git
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
75