Skip to content

docs: fix malformed since annotations - #42800

Open
Nicholas (Neekoras) wants to merge 1 commit into
microsoft:mainfrom
Neekoras:docs/fix-since-annotations
Open

Nicholas (Neekoras) wants to merge 1 commit into
microsoft:mainfrom
Neekoras:docs/fix-since-annotations

Conversation

@Neekoras

@Neekoras Nicholas (Neekoras) commented Sep 19, 2026

Copy link
Copy Markdown

Seven since: annotations in docs/src do not follow the vX.Y convention: one has a stray dot (v.1.30) and six are missing the v prefix. They are the only seven of 3,333 that do not match ^v\d+\.\d+$.

docs/src/api/class-cdpsession.md:144        * since: v.1.30
docs/src/api/class-cdpsessionevent.md:15    * since: 1.30
docs/src/api/class-apirequest.md:16         * since: 1.46
docs/src/api/class-browser.md:265           * since: 1.46
docs/src/api/class-browser.md:296           * since: 1.46
docs/src/api/class-browsertype.md:376       * since: 1.46
docs/src/test-api/class-testoptions.md:143  * since: 1.46

Five are the same clientCertificates option copy-pasted across files, each sitting directly beneath a sibling that reads v1.8 or v1.40.

extractSince in utils/doclint/api_parser.js takes the text after the colon verbatim, so these reach the generated API metadata unchanged. Because the clientCertificates entry fans out across its nested properties, the seven source lines produce 42 malformed since values in api.json; with this change that count is 0.

Only the format changes. No version number is altered, npm run doc passes, 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 and test-api/class-testoptions.md are not listed there. That issue bundles eight unrelated documentation problems, so this takes only the mechanical version-string item and leaves the rest untouched.

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.
@Neekoras

Copy link
Copy Markdown
Author

@microsoft-github-policy-service agree

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant