search

atom / language-todo

TODO highlighting package for Atom
Other
81 stars 66 forks source link

Add WARNING keyword to language-todo #74

Closed gwpantazes closed 6 years ago

gwpantazes commented 6 years ago

Requirements

All new code requires tests to ensure against regressions

^^ How do I run these tests?

Description of the Change

Add WARNING keyword to grammar as another todo keyword. Added to the README and snippets as well.

Alternate Designs

I feel like the WARNING keyword was something missing from the grammar, a negative callout of sorts with a more long-lived home in a comment that might not be fixed anytime soon.

Benefits

The WARNING keyword is a new negative todo word, and the language highlighting will bring more attention to known issues written in comments/text.

Possible Drawbacks

Another word in the grammar might be considered bloat.

Also WARNING might be considered outside of the scope of the TODO language, and maybe it should live in a different language.

Applicable Issues

There shouldn't be any issues since I just added 1 more keyword to the existing language and snippet.

50Wliu commented 6 years ago

All new code requires tests to ensure against regressions

This comes from the generic PR template. We don't require tests yet for this language.