Turn XML doc and Sig<->Impl mismatch warnings on by default#10457
Turn XML doc and Sig<->Impl mismatch warnings on by default#10457cartermp merged 5 commits intodotnet:mainfrom
Conversation
|
How likely is this to impact anyone from compiling their code? |
|
@TIHan For the signature file mismatch one, highly unlikely. The likelihood that someone has warnings as errors, uses signature files, intentionally mismatches parameter names, and is blocked from changing things feels like it's pretty much zero. For the XML doc one, it will likely impact more people because there are probably several libraries out there that have malformed or incorrect XML documentation. However, the likelihood that they would appreciate this warning is also quite high, because this fixes very real bugs for their consumers. |
|
Merging as per convo with @TIHan |
|
If we're turning these on, then unused variable warnings (in projects, not scripts) seem a good candidate too. These warnings catch so many bugs in real world code. |
|
I wouldn't mind doing that as well, we might as well just go for it and let feedback dictate if we back off. |
I think these should just be on by default.
This is technically a breaking change for anyone who has warnings set as errors, and should be treated like any circumstance where if we introduce a warning it will break people with that setting turned on.
That said, I think that these two checks move code towards being more correct, and especially in the case of the XML doc thing can catch some bugs that they might otherwise not easily catch.