-
Notifications
You must be signed in to change notification settings - Fork 789
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Do not check XmlDocs unless required #14156
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good in general, but it would be good to cover the functionality with tests covering the positive and negative cases.
@T-Gro, not sure if tests are needed here as this PR does not change the visible behavior in any way. The problem that this PR fixes is that checking XML docs is always done, even if its results are not required and therefore ignored. This PR allows analysis to be performed only when its results are required (i.e. |
That is what I meant - if the warnon is enabled, a warning should still be produced. |
There are a lot of tests for XmlDocs checking in with enabled 3390 diagnostic fsharp/tests/FSharp.Test.Utilities/Compiler.fs Lines 433 to 435 in 33f9cf8
I will add one test that checks for the absence of warnings with disabled diagnostic |
Currently, XmlDoc check is performed even if the corresponding diagnostic (3390) is not enabled in the .fsproj.
This PR suggests adding an option to DiagnosticOptions to not call analysis if not required.