[Excel] (Custom functions) Add custom enums article #5252
Conversation
|
Learn Build status updates of commit 949aa09: ✅ Validation status: passed
For more details, please refer to the build report. |
|
Learn Build status updates of commit 2225d74: ✅ Validation status: passed
For more details, please refer to the build report. |
|
Learn Build status updates of commit 2c1e25b: 💡 Validation status: suggestions
docs/images/custom-functions-custom-enum-autocomplete.png
For more details, please refer to the build report. Note: Your PR may contain errors or warnings or suggestions unrelated to the files you changed. This happens when external dependencies like GitHub alias, Microsoft alias, cross repo links are updated. Please use these instructions to resolve them. |
This comment was marked as outdated.
This comment was marked as outdated.
Sorry, something went wrong.
|
Learn Build status updates of commit c2e82be: 💡 Validation status: suggestions
docs/images/custom-functions-custom-enum-autocomplete.png
For more details, please refer to the build report. Note: Your PR may contain errors or warnings or suggestions unrelated to the files you changed. This happens when external dependencies like GitHub alias, Microsoft alias, cross repo links are updated. Please use these instructions to resolve them. |
|
Learn Build status updates of commit f59304d: 💡 Validation status: suggestions
docs/images/custom-functions-custom-enum-autocomplete.png
For more details, please refer to the build report. Note: Your PR may contain errors or warnings or suggestions unrelated to the files you changed. This happens when external dependencies like GitHub alias, Microsoft alias, cross repo links are updated. Please use these instructions to resolve them. |
| } | ||
| ``` | ||
|
|
||
| ## Edit enums in JSON metadata |
There was a problem hiding this comment.
Should this section be in the "Manually create JSON metadata for custom functions" article instead? I think that would help keep this article simple and help the common use case of people just using TypeScript.
There was a problem hiding this comment.
Ok, I'll move it. Thanks for the feedback!
Co-authored-by: Alex Jerabek <[email protected]>
|
Learn Build status updates of commit f298cda: 💡 Validation status: suggestions
docs/images/custom-functions-custom-enum-autocomplete.png
For more details, please refer to the build report. Note: Your PR may contain errors or warnings or suggestions unrelated to the files you changed. This happens when external dependencies like GitHub alias, Microsoft alias, cross repo links are updated. Please use these instructions to resolve them. |
|
Learn Build status updates of commit f5e4ec1:
|
| File | Status | Preview URL | Details |
|---|---|---|---|
| docs/excel/custom-functions-custom-enums.md | View | Details | |
| docs/images/custom-functions-custom-enum-autocomplete.png | 💡Suggestion | View | Details |
| docs/toc.yml | ✅Succeeded | View |
docs/excel/custom-functions-custom-enums.md
- Line 19, Column 244: [Warning: bookmark-not-found - See documentation]
Cannot find bookmark '#enums' in 'excel/custom-functions-json.md', did you mean '#result'?
docs/images/custom-functions-custom-enum-autocomplete.png
- Line 0, Column 0: [Suggestion: image-name-incomplete - See documentation]
The image name contains an incomplete word, misspelled word, acronym, or abbreviation that is disallowed.
For more details, please refer to the build report.
Note: Your PR may contain errors or warnings or suggestions unrelated to the files you changed. This happens when external dependencies like GitHub alias, Microsoft alias, cross repo links are updated. Please use these instructions to resolve them.
|
Learn Build status updates of commit 0b2701c: 💡 Validation status: suggestions
docs/images/custom-functions-custom-enum-autocomplete.png
For more details, please refer to the build report. Note: Your PR may contain errors or warnings or suggestions unrelated to the files you changed. This happens when external dependencies like GitHub alias, Microsoft alias, cross repo links are updated. Please use these instructions to resolve them. |
There was a problem hiding this comment.
Pull Request Overview
This PR adds a new article on using custom enums in Excel custom functions and wires it into the documentation table of contents.
- Adds a TOC entry for the new "Custom enums" topic under Excel custom functions
- Introduces
custom-functions-custom-enums.md, covering enum definition, reuse, localization, and compatibility
Reviewed Changes
Copilot reviewed 2 out of 3 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| docs/toc.yml | Inserted a new TOC item for the custom enums article |
| docs/excel/custom-functions-custom-enums.md | New documentation on defining and using custom enums in TypeScript |
Comments suppressed due to low confidence (2)
docs/toc.yml:680
- [nitpick] TOC
nameentries use Title Case for consistency with other items; consider renaming toCustom Enums.
- name: Custom enums
docs/excel/custom-functions-custom-enums.md:80
- The
@returnstag is empty; add a return type and description (e.g.,@returns {string} A formatted sum string.).
* @returns
|
|
||
| ## Use a custom enum multiple times | ||
|
|
||
| An custom enum can be reused in multiple functions, and it can be used as multiple parameters of a single function. A function can also have multiple enums as parameters at the same time. An enum parameter can be repeating or optional. |
There was a problem hiding this comment.
Grammar: Change An custom enum to A custom enum.
Copilot uses AI. Check for mistakes.
|
Learn Build status updates of commit 82c2d98: 💡 Validation status: suggestions
docs/images/custom-functions-custom-enum-autocomplete.png
For more details, please refer to the build report. Note: Your PR may contain errors or warnings or suggestions unrelated to the files you changed. This happens when external dependencies like GitHub alias, Microsoft alias, cross repo links are updated. Please use these instructions to resolve them. |
Note that the related JSDoc and metadata reference articles are updated in separate PR: #5240