Skip to content

[tools] (YML) Expand type aliases to include links #2249

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

Merged
merged 15 commits into from
Apr 23, 2025

Conversation

AlexJerabek
Copy link
Contributor

@AlexJerabek AlexJerabek commented Apr 8, 2025

This is a long PR to address #2245. Unfortunately, it touches every yaml file due to updates to js-yaml and how we're making small edits to the output of api-documenter.

The end result is adding a line to the type alias remarks with links to the included types. Here's what that looks like:
image

This is a big PR that's not feasible to review line by line. Instead, please look at pages in your feature area. Check enums, type aliases, interfaces, and classes.

Here is the staging link: https://review.learn.microsoft.com/en-us/javascript/api/excel/excel.cardlayout?view=excel-js-preview&branch=AlexJ-TypeDefExpansion

Copy link
Contributor

Learn Build status updates of commit c016171:

✅ Validation status: passed

File Status Preview URL Details
docs/docs-ref-autogen/common_preview/toc.yml ✅Succeeded View (common-js-preview || outlook-js-preview || excel-js-preview || onenote-js-1.1 || powerpoint-js-preview || word-js-preview)
docs/docs-ref-autogen/common/toc.yml ✅Succeeded View (>=common-js || >=outlook-js-1.1 || >=excel-js-1.1 || onenote-js-1.1 || >=powerpoint-js-1.1 || visio-js-1.1 || >=word-js-1.1)
View (common-js || <outlook-js-preview || <excel-js-preview || <powerpoint-js-preview || <word-js-preview)
View (common-js-preview || outlook-js-preview || excel-js-preview || onenote-js-1.1 || powerpoint-js-preview || word-js-preview)
docs/docs-ref-autogen/excel/custom-functions-runtime.yml ✅Succeeded View (excel-js-preview)
docs/docs-ref-autogen/excel/custom-functions-runtime/customfunctions.cancelableinvocation.yml ✅Succeeded View (excel-js-preview)
docs/docs-ref-autogen/excel/custom-functions-runtime/customfunctions.error.yml ✅Succeeded View (excel-js-preview)
docs/docs-ref-autogen/excel/custom-functions-runtime/customfunctions.errorcode.yml ✅Succeeded View (excel-js-preview)
docs/docs-ref-autogen/excel/custom-functions-runtime/customfunctions.invocation.yml ✅Succeeded View (excel-js-preview)
docs/docs-ref-autogen/excel/custom-functions-runtime/customfunctions.streaminginvocation.yml ✅Succeeded View (excel-js-preview)
docs/docs-ref-autogen/excel/excel.yml ✅Succeeded View (excel-js-preview)
docs/docs-ref-autogen/excel/excel/excel.aggregationfunction.yml ✅Succeeded View (excel-js-preview)
docs/docs-ref-autogen/excel/excel/excel.alloweditrange.yml ✅Succeeded View (excel-js-preview)
docs/docs-ref-autogen/excel/excel/excel.alloweditrangecollection.yml ✅Succeeded View (excel-js-preview)
docs/docs-ref-autogen/excel/excel/excel.alloweditrangeoptions.yml ✅Succeeded View (excel-js-preview)
docs/docs-ref-autogen/excel/excel/excel.application.yml ✅Succeeded View (excel-js-preview)
docs/docs-ref-autogen/excel/excel/excel.arraycellvalue.yml ✅Succeeded View (excel-js-preview)
docs/docs-ref-autogen/excel/excel/excel.arrowheadlength.yml ✅Succeeded View (excel-js-preview)
docs/docs-ref-autogen/excel/excel/excel.arrowheadstyle.yml ✅Succeeded View (excel-js-preview)
docs/docs-ref-autogen/excel/excel/excel.arrowheadwidth.yml ✅Succeeded View (excel-js-preview)
docs/docs-ref-autogen/excel/excel/excel.autofilltype.yml ✅Succeeded View (excel-js-preview)
docs/docs-ref-autogen/excel/excel/excel.autofilter.yml ✅Succeeded View (excel-js-preview)
docs/docs-ref-autogen/excel/excel/excel.base64encodedimage.yml ✅Succeeded View (excel-js-preview)
docs/docs-ref-autogen/excel/excel/excel.base64encodingtype.yml ✅Succeeded View (excel-js-preview)
docs/docs-ref-autogen/excel/excel/excel.basiccardlayout.yml ✅Succeeded View (excel-js-preview)
docs/docs-ref-autogen/excel/excel/excel.basiccompactlayout.yml ✅Succeeded View (excel-js-preview)
docs/docs-ref-autogen/excel/excel/excel.basicdatavalidation.yml ✅Succeeded View (excel-js-preview)

This comment lists only the first 25 files in the pull request.
For more details, please refer to the build report.

For any questions, please:

Copy link
Contributor

@alison-mk alison-mk left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Excel files look good to me. I spot-checked ~25 items, at least 4 of each kind (type alias, interface, enum, and class).

Copy link
Contributor

@samantharamon samantharamon left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good for Outlook and Common APIs.

Copy link
Contributor

Learn Build status updates of commit 5bc8ad5:

✅ Validation status: passed

File Status Preview URL Details
docs/docs-ref-autogen/common_preview/toc.yml ✅Succeeded View (common-js-preview || outlook-js-preview || excel-js-preview || onenote-js-1.1 || powerpoint-js-preview || word-js-preview)
docs/docs-ref-autogen/common/toc.yml ✅Succeeded View (>=common-js || >=outlook-js-1.1 || >=excel-js-1.1 || onenote-js-1.1 || >=powerpoint-js-1.1 || visio-js-1.1 || >=word-js-1.1)
View (common-js || <outlook-js-preview || <excel-js-preview || <powerpoint-js-preview || <word-js-preview)
View (common-js-preview || outlook-js-preview || excel-js-preview || onenote-js-1.1 || powerpoint-js-preview || word-js-preview)
docs/docs-ref-autogen/excel/custom-functions-runtime.yml ✅Succeeded View (excel-js-preview)
docs/docs-ref-autogen/excel/custom-functions-runtime/customfunctions.cancelableinvocation.yml ✅Succeeded View (excel-js-preview)
docs/docs-ref-autogen/excel/custom-functions-runtime/customfunctions.error.yml ✅Succeeded View (excel-js-preview)
docs/docs-ref-autogen/excel/custom-functions-runtime/customfunctions.errorcode.yml ✅Succeeded View (excel-js-preview)
docs/docs-ref-autogen/excel/custom-functions-runtime/customfunctions.invocation.yml ✅Succeeded View (excel-js-preview)
docs/docs-ref-autogen/excel/custom-functions-runtime/customfunctions.streaminginvocation.yml ✅Succeeded View (excel-js-preview)
docs/docs-ref-autogen/excel/excel.yml ✅Succeeded View (excel-js-preview)
docs/docs-ref-autogen/excel/excel/excel.aggregationfunction.yml ✅Succeeded View (excel-js-preview)
docs/docs-ref-autogen/excel/excel/excel.alloweditrange.yml ✅Succeeded View (excel-js-preview)
docs/docs-ref-autogen/excel/excel/excel.alloweditrangecollection.yml ✅Succeeded View (excel-js-preview)
docs/docs-ref-autogen/excel/excel/excel.alloweditrangeoptions.yml ✅Succeeded View (excel-js-preview)
docs/docs-ref-autogen/excel/excel/excel.application.yml ✅Succeeded View (excel-js-preview)
docs/docs-ref-autogen/excel/excel/excel.arraycellvalue.yml ✅Succeeded View (excel-js-preview)
docs/docs-ref-autogen/excel/excel/excel.arrowheadlength.yml ✅Succeeded View (excel-js-preview)
docs/docs-ref-autogen/excel/excel/excel.arrowheadstyle.yml ✅Succeeded View (excel-js-preview)
docs/docs-ref-autogen/excel/excel/excel.arrowheadwidth.yml ✅Succeeded View (excel-js-preview)
docs/docs-ref-autogen/excel/excel/excel.autofilltype.yml ✅Succeeded View (excel-js-preview)
docs/docs-ref-autogen/excel/excel/excel.autofilter.yml ✅Succeeded View (excel-js-preview)
docs/docs-ref-autogen/excel/excel/excel.base64encodedimage.yml ✅Succeeded View (excel-js-preview)
docs/docs-ref-autogen/excel/excel/excel.base64encodingtype.yml ✅Succeeded View (excel-js-preview)
docs/docs-ref-autogen/excel/excel/excel.basiccardlayout.yml ✅Succeeded View (excel-js-preview)
docs/docs-ref-autogen/excel/excel/excel.basiccompactlayout.yml ✅Succeeded View (excel-js-preview)
docs/docs-ref-autogen/excel/excel/excel.basicdatavalidation.yml ✅Succeeded View (excel-js-preview)

This comment lists only the first 25 files in the pull request.
For more details, please refer to the build report.

For any questions, please:

@AlexJerabek AlexJerabek merged commit aee0a32 into main Apr 23, 2025
1 check passed
@AlexJerabek AlexJerabek deleted the AlexJ-TypeDefExpansion branch April 23, 2025 03:37
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.

4 participants