-
Notifications
You must be signed in to change notification settings - Fork 802
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
Check XML doc parameter names for FSharp.Core via opt-in checking #10118
Conversation
This is ready (once green - having some niggling issues) |
This is now ready for review |
@cartermp I think it makes sense to document
in the Microsoft F# docs. I was going to put something under "docs" but it's likely better in the actual guide |
Side note: I wanted to add separate warnings for
However there are some issues with that. Notably
But those are for later. What we have in this PR is enough to pin down quality for FCS and FSharp.Core docs. |
@@ -2,7559 +2,7594 @@ | |||
<xliff xmlns="urn:oasis:names:tc:xliff:document:1.2" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" version="1.2" xsi:schemaLocation="urn:oasis:names:tc:xliff:document:1.2 xliff-core-1.2-transitional.xsd"> | |||
<file datatype="xml" source-language="en" target-language="ja" original="../FSComp.resx"> | |||
<body> | |||
<trans-unit id="chkFeatureNotLanguageSupported"> |
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.
How did this enormous diff occur?
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.
Not sure
@KevinRansom Thank you, it's great to have this in |
Relevant documentation PR: dotnet/docs#20645 |
…tnet#10118) * optionally check xml doc comments for xml validity * check xml docs * check xml docs * xml checks 2 * fix baselines * check parameter names * fix baseline * check parameters names * allow delegate param doc * fix FSHarp.Core doc problems * fix docs * fix docs * fix diagnostics * fix diagnostics * update baselines * provide elaborated xml docs in FCS API * fix test * use 38 ver * fix build * check docs of FCS * start to fix FCS docs * complete some FCS docs and enable doc checking * fix duplicate checking * fix duplicate checking * update baselines and xlf * correct xml text for legacy test Co-authored-by: Don Syme <[email protected]>
…tnet#10118) * optionally check xml doc comments for xml validity * check xml docs * check xml docs * xml checks 2 * fix baselines * check parameter names * fix baseline * check parameters names * allow delegate param doc * fix FSHarp.Core doc problems * fix docs * fix docs * fix diagnostics * fix diagnostics * update baselines * provide elaborated xml docs in FCS API * fix test * use 38 ver * fix build * check docs of FCS * start to fix FCS docs * complete some FCS docs and enable doc checking * fix duplicate checking * fix duplicate checking * update baselines and xlf * correct xml text for legacy test Co-authored-by: Don Syme <[email protected]>
…tnet#10118) * optionally check xml doc comments for xml validity * check xml docs * check xml docs * xml checks 2 * fix baselines * check parameter names * fix baseline * check parameters names * allow delegate param doc * fix FSHarp.Core doc problems * fix docs * fix docs * fix diagnostics * fix diagnostics * update baselines * provide elaborated xml docs in FCS API * fix test * use 38 ver * fix build * check docs of FCS * start to fix FCS docs * complete some FCS docs and enable doc checking * fix duplicate checking * fix duplicate checking * update baselines and xlf * correct xml text for legacy test Co-authored-by: Don Syme <[email protected]>
Fixes mistakes in FSharp.Core XML docs
Fix mistakes in FCS docs
Implements the opt-in XML document checking
/warnon:3390
and applies it to FSharp.Core,When
/warnon:3390
is enabled (e.g. for FCS and FSharp.Core):checks
<param name="xyz">
and<paramref name="xyz">
it checks thatxyz
is a valid parameter name for the thing being documentschecks that if any parameter is given docs, then all are given docs
Adds the ability to get the elaborated (e.g. with summary tags) XML from the FCS API, which we should always have allowed. This will become more important if/when we support cross-reference
cref
elaboration in XML docs.Fixes a bug where you couldn't add documentation to an implicit constructor, see this stack overflow question.
Aside: This PR also contains the beginning of code for cross-reference checking and elaboration, allowing the use of "short name" forms for cross references, including rename-refactor on these. However that code is not enabled.