Skip union case tester properties in API docs - #1315
Open
nojaf wants to merge 1 commit into
Open
Conversation
The compiler synthesizes an IsCase property for every union case. They cannot carry XML documentation, so they were listed as undocumented members on union pages and FsDocsWarnOnMissingDocs reported FD0001 for each one, about half of all warnings for a union-heavy assembly. Treat IsUnionCaseTester like IsCompilerGenerated when reading members, so the testers are neither documented nor reported as missing.
nojaf
changed the title
17 tasks
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The compiler synthesizes an IsCase property for every union case. They cannot carry XML documentation, so they were listed as undocumented members on union pages and FsDocsWarnOnMissingDocs reported FD0001 for each one, about half of all warnings for a union-heavy assembly.
Treat IsUnionCaseTester like IsCompilerGenerated when reading members, so the testers are neither documented nor reported as missing.
@dsyme would like a review from you on this. I think this is fine, but a another set of eyes might be worth it.
Fixes #1313