DocumentationDoesNotContainTodo

Report special marks in comments.

check : Array String -> Check

Report a given set of words and symbols that have special meaning in your codebase like REPLACEME, TODO, - [ ], BUG, FIXME.

They will be looked for in all comments (line --, block and documentation), the gren.json summary and all extra files like the readme and changelog.

These mark code that compiles and should be able to run but still requires attention in certain parts in the future.

not reported with check [ "TODO" ]

error =
    { ...
    , fix = [] -- consider removing the problematic call
    }

reported with check [ "TODO" ]

error =
    { ...
    , fix = [] -- TODO consider removing the problematic call
    }