avh4/elm-format

Backslash prepended to underscores in comments

Open

#587 geöffnet am 24. Dez. 2018

Auf GitHub ansehen
 (2 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)Haskell (148 Forks)batch import
help wanted

Repository-Metriken

Stars
 (1.329 Stars)
PR-Merge-Metriken
 (Keine gemergten PRs in 30 T)

Beschreibung

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-Richtung
Untersuche den Lexer oder die Formatierungsregeln im Quellcode von elm format, insbesondere den Teil, der die Kommentarformatierung behandelt. Das Problem betrifft die unerwünschte Backslash Escape von Unterstrichen innerhalb von Kommentaren. Suche nach der Logik, die Unterstriche verarbeitet, und stelle sicher, dass sie nicht innerhalb von Kommentaren angewendet wird. Überprüfe vorhandene Tests zur Kommentarformatierung, um das erwartete Verhalten zu verstehen.
Tech Stack
Keine
Domain
tooling
Issue Type
Fehler
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-3 Stunden
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
Git
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
75