Skip to content

[Excel] (Custom functions) Clean up repeating parameters guidance #5260

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 1 commit into from
Jun 27, 2025

Conversation

alison-mk
Copy link
Contributor

No description provided.

Copy link
Contributor

Learn Build status updates of commit 385395f:

✅ Validation status: passed

File Status Preview URL Details
docs/excel/custom-functions-parameter-options.md ✅Succeeded View

For more details, please refer to the build report.

Copy link
Contributor

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

This PR refreshes the Excel custom functions documentation by updating metadata, clarifying repeating-parameter rules, and consolidating declaration guidance.

  • Bumped the document date to 06/26/2025.
  • Added a note about repeating parameters needing to be last and unique.
  • Reformatted examples (bold syntax) and merged TypeScript, JavaScript, and JSON instructions into a single declaration section.
Comments suppressed due to low confidence (3)

docs/excel/custom-functions-parameter-options.md:220

  • [nitpick] Use '### Declaring repeating parameters' to maintain consistency with the noun-based style of other section headings.
### Declare repeating parameters

docs/excel/custom-functions-parameter-options.md:222

  • Add a comma after 'For example' ('For example, in TypeScript, …') to improve readability and adhere to standard grammar.
To declare a repeating parameter, indicate that the parameter is multi-dimensional. For example in TypeScript, `ADD(values: number[])` would indicate a one-dimensional array, `ADD(values:number[][])` would indicate a two-dimensional array, and so on. In JavaScript, use `@param values {number[]}` for one-dimensional arrays, `@param <name> {number[][]}` for two-dimensional arrays, and so on for more dimensions.

docs/excel/custom-functions-parameter-options.md:224

  • Wrap the JSON keys repeating and dimensionality in backticks to clearly distinguish them as code elements.
For [manually-created JSON metadata](custom-functions-json.md), ensure that the parameter is specified as `"repeating": true` and `"dimensionality": "matrix"` in your JSON file.

@alison-mk alison-mk merged commit 2799a00 into main Jun 27, 2025
2 checks passed
@alison-mk alison-mk deleted the alison-mk-repeating-param branch June 27, 2025 20:43
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.

A few issues with custom function parameter option documentation
2 participants