Formally define the difference between `error`, `warning`, and `note` diagnostics

stjude-rust-labs / wdl

Rust crates for working with Workflow Description Language (WDL) documents.

Apache License 2.0

26 stars 6 forks source link

Closed a-frantz closed 1 month ago

a-frantz commented 1 month ago

error is pretty straightforward, it is used when parsed WDL is incorrect or invalid in some way.
warning should be used when encountered WDL is confusing, problematic, error-prone, etc. but not "invalid".
note would be everything else and is mostly issues of style conformity

If we all agree on the above, we should

write it down somewhere public that it can be referenced in the future
go through all our existing lints and make sure they use warning/note appropriately

peterhuene commented 1 month ago

This definition aligns with my concept of error, warning, and note.

claymcleod commented 1 month ago

Looks good to me. It could probably be added in a new DEVELOPMENT.md guidance doc or something similar.