docs: fix malformed since annotations - #42800
Open
Nicholas (Neekoras) wants to merge 1 commit into
Open
Nicholas (Neekoras) wants to merge 1 commit into
Nicholas (Neekoras) wants to merge 1 commit into
Conversation
Seven `since:` annotations did not match the `vX.Y` convention used by the other 3,326: one had a stray dot (`v.1.30`) and six were missing the `v` prefix. Five are the same `clientCertificates` option copy-pasted across files, each directly beneath a sibling reading `v1.8` or `v1.40`. `extractSince` takes the text after the colon verbatim, with no validation, so these flowed into the generated API metadata unchanged. Since the `clientCertificates` entry fans out across its nested properties, the seven source lines produced 42 malformed `since` values in `api.json`; that count is now zero. Only the format changes. No version number is altered.
Author
|
@microsoft-github-policy-service agree |
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
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.
Seven
since:annotations indocs/srcdo not follow thevX.Yconvention: one has a stray dot (v.1.30) and six are missing thevprefix. They are the only seven of 3,333 that do not match^v\d+\.\d+$.Five are the same
clientCertificatesoption copy-pasted across files, each sitting directly beneath a sibling that readsv1.8orv1.40.extractSinceinutils/doclint/api_parser.jstakes the text after the colon verbatim, so these reach the generated API metadata unchanged. Because theclientCertificatesentry fans out across its nested properties, the seven source lines produce 42 malformedsincevalues inapi.json; with this change that count is 0.Only the format changes. No version number is altered,
npm run docpasses, and nothing else in the generated output differs.Item 8 of #42544 catalogues five of these seven (credit to Ashraf Ali (@ashrafiucse));
class-browser.md's second occurrence andtest-api/class-testoptions.mdare not listed there. That issue bundles eight unrelated documentation problems, so this takes only the mechanical version-string item and leaves the rest untouched.