search

the-sett / elm-syntax-dsl

A DSL for creating Elm syntax trees and pretty printing Elm source code.
BSD 3-Clause "New" or "Revised" License
20 stars 4 forks source link

Make it clear that `markdown` and `code` are for building these things in comments. #28

Open rupertlssmith opened 3 years ago

rupertlssmith commented 3 years ago 
markdown : String -> Comment a -> Comment a
code : String -> Comment a -> Comment a

Its obvious enough from the type signatures, but calling these something like markdownComment and codeComment might make their purpose clearer. The names are too generic.

lue-bird commented 3 years ago

I'd go with addDocMarkdown and addDocCode. markdownComment doesn't sound like a builder function.

rupertlssmith commented 3 years ago

Yeah its better. Might hold off on publishing a fix for this as with the API change its a major version bump?