search

icerpc / slicec

The Slice compiler library
Apache License 2.0
13 stars 5 forks source link

Improved Lint Coverage/Messages. #630

Closed InsertCreativityHere closed 1 year ago

InsertCreativityHere commented 1 year ago

This PR reworks our lint messages and emission (mostly IncorrectDocComment). It adds linting for cases we aren't checking: mismatches between return parameter names, using @param outside operations, etc. It adds tests to cover these new lints, and for old lints that lacked test coverage. And it rewrites our lint messages to improve consistency of messaging and readability.

For accessibility, you can find a full list of the messages here, instead of having to hunt through the code for them. https://zeroc.atlassian.net/wiki/spaces/~austin/pages/1302954011/Error+and+Lint+Reference

InsertCreativityHere commented 1 year ago

I combined the notes and messages together into a single message for all the redundant notes.

pepone commented 1 year ago

CI shows that some tests for error messages need fixing, aside from that code looks good

InsertCreativityHere commented 1 year ago

CI shows that some tests for error messages need fixing, aside from that code looks good

Yeah, I didn't want to fix the tests until we had the messages nailed down! If everyone's okay with them, I'll fix the tests and merge then.