lpil / dogma

:closed_lock_with_key: A code style linter for Elixir
Other
471 stars 52 forks source link

Add configuration allow_multiple_hashes to CommentFormat #251

Closed axelson closed 6 years ago

axelson commented 6 years ago

(this is a reimplementation of #222)

Currently, Dogma raises a CommentFormat error for comments that have multiple '#' characters before the beginning of the comment eg ## Currently invalid comment.

This PR adds an allow_multiple_hashes configuration to the CommentFormat rule that allows multiple # at the beginning of a comment.

Points of reference in favour of allowing multiple # characters before a comment:

axelson commented 6 years ago

@lpil Is there anything needed to improve this PR?