From 07161a059451c67a6ec8eee539e6d0d3e64662d3 Mon Sep 17 00:00:00 2001 From: Cursor Agent Date: Tue, 14 Jul 2026 12:26:13 +0000 Subject: [PATCH] refactor(metadata): use snake_case for all catalogue parameter names (HF-249) Normalize every FunctionDoc parameter name to snake_case for a consistent function-picker UI, replacing the mixed Title-case/underscore styles (e.g. Sum_Range/Sumrange/Number1/Number_1). Sibling params now agree (SUMIF & SUMIFS both use sum_range; MATCH & VLOOKUP both search_criterion). The migration generator (scripts/hf249-migrate-function-docs.ts) now emits snake_case via a shared toSnakeCase helper (camel/acronym splitting, separator unification, digits kept attached) plus a small segmentation table for run-on tokens the docs left unsplit; its main() is guarded so the helper is importable without side effects. Descriptions, examples and documentationUrl are untouched; custom-function positional names (Arg1, Arg2) are unchanged. Co-authored-by: Kuba Sekowski --- scripts/hf249-migrate-function-docs.ts | 56 +++++- .../categories/array-manipulation.ts | 12 +- .../functionMetadata/categories/database.ts | 24 +-- .../categories/date-and-time.ts | 48 ++--- .../categories/engineering.ts | 92 ++++----- .../functionMetadata/categories/financial.ts | 58 +++--- .../categories/information.ts | 30 +-- .../functionMetadata/categories/logical.ts | 18 +- .../categories/lookup-and-reference.ts | 26 +-- .../categories/math-and-trigonometry.ts | 146 +++++++------- .../categories/matrix-functions.ts | 8 +- .../functionMetadata/categories/operator.ts | 30 +-- .../categories/statistical.ts | 178 +++++++++--------- .../functionMetadata/categories/text.ts | 52 ++--- 14 files changed, 410 insertions(+), 368 deletions(-) diff --git a/scripts/hf249-migrate-function-docs.ts b/scripts/hf249-migrate-function-docs.ts index f09be0cdd..6b40bb8fe 100644 --- a/scripts/hf249-migrate-function-docs.ts +++ b/scripts/hf249-migrate-function-docs.ts @@ -29,9 +29,47 @@ const DOC_PATH = path.join(REPO_ROOT, 'docs/guide/built-in-functions.md') const CATEGORIES_DIR = path.join(REPO_ROOT, 'src/interpreter/functionMetadata/categories') const INDEX_PATH = path.join(REPO_ROOT, 'src/interpreter/functionMetadata/index.ts') -/** Parameter names the documentation under-specifies relative to the implementation arity. */ +/** Parameter names the documentation under-specifies relative to the implementation arity (already snake_case). */ const PARAMETER_NAME_OVERRIDES: Record = { - 'T.TEST': ['Array1', 'Array2', 'Tails', 'Type'], + 'T.TEST': ['array1', 'array2', 'tails', 'type'], +} + +/** + * Word-segmentation fixes for parameter tokens the documentation writes as a single run-on word (e.g. `Sumrange`), + * so they read consistently with their multi-word siblings (`Sum_Range` -> `sum_range`). Keyed by the mechanically + * snake-cased token; the value is the corrected snake_case name. + */ +const SNAKE_CASE_SEGMENTATION: Record = { + sumrange: 'sum_range', + searchcriterion: 'search_criterion', + logicalvalue: 'logical_value', + datestring: 'date_string', + timestring: 'time_string', + startdate: 'start_date', + minimumlength: 'minimum_length', + lowerbound: 'lower_bound', + upperbound: 'upper_bound', + numberx: 'number_x', + numbery: 'number_y', +} + +/** + * Converts a raw parameter name to snake_case: lowercase words joined by underscores, with camelCase/PascalCase and + * acronym boundaries split, existing separators unified, and trailing digits kept attached to their word + * (`Number1`, `Number_1` -> `number1`). A small segmentation table then fixes run-on tokens the docs left unsplit. + * + * @param {string} name - the raw parameter name from the syntax column + */ +export function toSnakeCase(name: string): string { + const mechanical = name + .replace(/([a-z0-9])([A-Z])/g, '$1_$2') + .replace(/([A-Z]+)([A-Z][a-z])/g, '$1_$2') + .replace(/[\s.\-]+/g, '_') + .toLowerCase() + .replace(/_+(\d)/g, '$1') + .replace(/_+/g, '_') + .replace(/^_|_$/g, '') + return SNAKE_CASE_SEGMENTATION[mechanical] ?? mechanical } interface DocRow { @@ -94,8 +132,9 @@ function uniquify(names: string[]): string[] { } /** - * Produces exactly `arity` unique, non-empty parameter names. The syntax column lists `Name1, Name2, ...NameN` - * for repeating groups, so the first `arity` names already collapse those groups onto the implementation arity. + * Produces exactly `arity` unique, non-empty snake_case parameter names. The syntax column lists + * `Name1, Name2, ...NameN` for repeating groups, so the first `arity` names already collapse those groups onto the + * implementation arity; each is normalized to snake_case and any shortfall is padded with `arg1`, `arg2`, ... */ function deriveParameterNames(id: string, syntax: string, arity: number): string[] { const override = PARAMETER_NAME_OVERRIDES[id] @@ -105,9 +144,9 @@ function deriveParameterNames(id: string, syntax: string, arity: number): string } return override } - const names = parseSyntaxNames(syntax).slice(0, arity) + const names = parseSyntaxNames(syntax).slice(0, arity).map(toSnakeCase) while (names.length < arity) { - names.push(`Arg${names.length + 1}`) + names.push(`arg${names.length + 1}`) } return uniquify(names) } @@ -231,4 +270,7 @@ function main(): void { console.log(`wrote ${path.relative(REPO_ROOT, INDEX_PATH)}; ${total} functions across ${categories.length} categories`) } -main() +// Only regenerate when executed directly; guarded so helpers (e.g. `toSnakeCase`) can be imported without side effects. +if (require.main === module) { + main() +} diff --git a/src/interpreter/functionMetadata/categories/array-manipulation.ts b/src/interpreter/functionMetadata/categories/array-manipulation.ts index 793f8533a..bf03946af 100644 --- a/src/interpreter/functionMetadata/categories/array-manipulation.ts +++ b/src/interpreter/functionMetadata/categories/array-manipulation.ts @@ -13,31 +13,31 @@ export const ARRAY_MANIPULATION_DOCS: Record = { ARRAY_CONSTRAIN: { category: 'Array manipulation', shortDescription: 'Truncates an array to given dimensions.', - parameters: [{name: 'Array', description: ''}, {name: 'Height', description: ''}, {name: 'Width', description: ''}], + parameters: [{name: 'array', description: ''}, {name: 'height', description: ''}, {name: 'width', description: ''}], }, ARRAYFORMULA: { category: 'Array manipulation', shortDescription: 'Enables the array arithmetic mode for a single formula.', - parameters: [{name: 'Formula', description: ''}], + parameters: [{name: 'formula', description: ''}], }, FILTER: { category: 'Array manipulation', shortDescription: 'Filters an array, based on multiple conditions (boolean arrays).', - parameters: [{name: 'SourceArray', description: ''}, {name: 'BoolArray1', description: ''}], + parameters: [{name: 'source_array', description: ''}, {name: 'bool_array1', description: ''}], }, SEQUENCE: { category: 'Array manipulation', shortDescription: 'Returns an array of sequential numbers.', - parameters: [{name: 'Rows', description: ''}, {name: 'Cols', description: ''}, {name: 'Start', description: ''}, {name: 'Step', description: ''}], + parameters: [{name: 'rows', description: ''}, {name: 'cols', description: ''}, {name: 'start', description: ''}, {name: 'step', description: ''}], }, VSTACK: { category: 'Array manipulation', shortDescription: 'Stacks arrays vertically into a single array.', - parameters: [{name: 'Array1', description: ''}], + parameters: [{name: 'array1', description: ''}], }, HSTACK: { category: 'Array manipulation', shortDescription: 'Stacks arrays horizontally into a single array.', - parameters: [{name: 'Array1', description: ''}], + parameters: [{name: 'array1', description: ''}], }, } diff --git a/src/interpreter/functionMetadata/categories/database.ts b/src/interpreter/functionMetadata/categories/database.ts index 89949d10d..4a2d3e1d7 100644 --- a/src/interpreter/functionMetadata/categories/database.ts +++ b/src/interpreter/functionMetadata/categories/database.ts @@ -13,61 +13,61 @@ export const DATABASE_DOCS: Record = { DAVERAGE: { category: 'Database', shortDescription: 'Returns the average of all values in a database field that match the given criteria.', - parameters: [{name: 'Database', description: ''}, {name: 'Field', description: ''}, {name: 'Criteria', description: ''}], + parameters: [{name: 'database', description: ''}, {name: 'field', description: ''}, {name: 'criteria', description: ''}], }, DCOUNT: { category: 'Database', shortDescription: 'Counts the cells containing numbers in a database field that match the given criteria.', - parameters: [{name: 'Database', description: ''}, {name: 'Field', description: ''}, {name: 'Criteria', description: ''}], + parameters: [{name: 'database', description: ''}, {name: 'field', description: ''}, {name: 'criteria', description: ''}], }, DCOUNTA: { category: 'Database', shortDescription: 'Counts the non-empty cells in a database field that match the given criteria.', - parameters: [{name: 'Database', description: ''}, {name: 'Field', description: ''}, {name: 'Criteria', description: ''}], + parameters: [{name: 'database', description: ''}, {name: 'field', description: ''}, {name: 'criteria', description: ''}], }, DGET: { category: 'Database', shortDescription: 'Returns the single value from a database field that matches the given criteria. Returns #VALUE! if no records match, and #NUM! if more than one record matches.', - parameters: [{name: 'Database', description: ''}, {name: 'Field', description: ''}, {name: 'Criteria', description: ''}], + parameters: [{name: 'database', description: ''}, {name: 'field', description: ''}, {name: 'criteria', description: ''}], }, DMAX: { category: 'Database', shortDescription: 'Returns the maximum value in a database field that matches the given criteria.', - parameters: [{name: 'Database', description: ''}, {name: 'Field', description: ''}, {name: 'Criteria', description: ''}], + parameters: [{name: 'database', description: ''}, {name: 'field', description: ''}, {name: 'criteria', description: ''}], }, DMIN: { category: 'Database', shortDescription: 'Returns the minimum value in a database field that matches the given criteria.', - parameters: [{name: 'Database', description: ''}, {name: 'Field', description: ''}, {name: 'Criteria', description: ''}], + parameters: [{name: 'database', description: ''}, {name: 'field', description: ''}, {name: 'criteria', description: ''}], }, DPRODUCT: { category: 'Database', shortDescription: 'Returns the product of all values in a database field that match the given criteria.', - parameters: [{name: 'Database', description: ''}, {name: 'Field', description: ''}, {name: 'Criteria', description: ''}], + parameters: [{name: 'database', description: ''}, {name: 'field', description: ''}, {name: 'criteria', description: ''}], }, DSTDEV: { category: 'Database', shortDescription: 'Returns the sample standard deviation of all values in a database field that match the given criteria.', - parameters: [{name: 'Database', description: ''}, {name: 'Field', description: ''}, {name: 'Criteria', description: ''}], + parameters: [{name: 'database', description: ''}, {name: 'field', description: ''}, {name: 'criteria', description: ''}], }, DSTDEVP: { category: 'Database', shortDescription: 'Returns the population standard deviation of all values in a database field that match the given criteria.', - parameters: [{name: 'Database', description: ''}, {name: 'Field', description: ''}, {name: 'Criteria', description: ''}], + parameters: [{name: 'database', description: ''}, {name: 'field', description: ''}, {name: 'criteria', description: ''}], }, DSUM: { category: 'Database', shortDescription: 'Returns the sum of all values in a database field that match the given criteria.', - parameters: [{name: 'Database', description: ''}, {name: 'Field', description: ''}, {name: 'Criteria', description: ''}], + parameters: [{name: 'database', description: ''}, {name: 'field', description: ''}, {name: 'criteria', description: ''}], }, DVAR: { category: 'Database', shortDescription: 'Returns the sample variance of all values in a database field that match the given criteria.', - parameters: [{name: 'Database', description: ''}, {name: 'Field', description: ''}, {name: 'Criteria', description: ''}], + parameters: [{name: 'database', description: ''}, {name: 'field', description: ''}, {name: 'criteria', description: ''}], }, DVARP: { category: 'Database', shortDescription: 'Returns the population variance of all values in a database field that match the given criteria.', - parameters: [{name: 'Database', description: ''}, {name: 'Field', description: ''}, {name: 'Criteria', description: ''}], + parameters: [{name: 'database', description: ''}, {name: 'field', description: ''}, {name: 'criteria', description: ''}], }, } diff --git a/src/interpreter/functionMetadata/categories/date-and-time.ts b/src/interpreter/functionMetadata/categories/date-and-time.ts index 91a3d7c9b..fce033bb0 100644 --- a/src/interpreter/functionMetadata/categories/date-and-time.ts +++ b/src/interpreter/functionMetadata/categories/date-and-time.ts @@ -13,77 +13,77 @@ export const DATE_AND_TIME_DOCS: Record = { DATE: { category: 'Date and time', shortDescription: 'Returns the specified date as the number of full days since [`nullDate`](../api/interfaces/configparams.md#nulldate).', - parameters: [{name: 'Year', description: ''}, {name: 'Month', description: ''}, {name: 'Day', description: ''}], + parameters: [{name: 'year', description: ''}, {name: 'month', description: ''}, {name: 'day', description: ''}], }, DATEDIF: { category: 'Date and time', shortDescription: 'Calculates distance between two dates.
Supported units: "D" (days), "M" (months), "Y" (years), "MD" (days ignoring months and years), "YM" (months ignoring years), or "YD" (days ignoring years).', - parameters: [{name: 'Date1', description: ''}, {name: 'Date2', description: ''}, {name: 'Unit', description: ''}], + parameters: [{name: 'date1', description: ''}, {name: 'date2', description: ''}, {name: 'unit', description: ''}], }, DATEVALUE: { category: 'Date and time', shortDescription: 'Parses a date string and returns it as the number of full days since [`nullDate`](../api/interfaces/configparams.md#nulldate).
Accepts formats set by the [`dateFormats`](../api/interfaces/configparams.md#dateformats) option.', - parameters: [{name: 'Datestring', description: ''}], + parameters: [{name: 'date_string', description: ''}], }, DAY: { category: 'Date and time', shortDescription: 'Returns the day of the given date value.', - parameters: [{name: 'Number', description: ''}], + parameters: [{name: 'number', description: ''}], }, DAYS: { category: 'Date and time', shortDescription: 'Calculates the difference between two date values.', - parameters: [{name: 'Date2', description: ''}, {name: 'Date1', description: ''}], + parameters: [{name: 'date2', description: ''}, {name: 'date1', description: ''}], }, DAYS360: { category: 'Date and time', shortDescription: 'Calculates the difference between two date values in days, in 360-day basis.', - parameters: [{name: 'Date2', description: ''}, {name: 'Date1', description: ''}, {name: 'Format', description: ''}], + parameters: [{name: 'date2', description: ''}, {name: 'date1', description: ''}, {name: 'format', description: ''}], }, EDATE: { category: 'Date and time', shortDescription: 'Shifts the given startdate by given number of months and returns it as the number of full days since [`nullDate`](../api/interfaces/configparams.md#nulldate).[^non-odff]', - parameters: [{name: 'Startdate', description: ''}, {name: 'Months', description: ''}], + parameters: [{name: 'start_date', description: ''}, {name: 'months', description: ''}], }, EOMONTH: { category: 'Date and time', shortDescription: 'Returns the date of the last day of a month which falls months away from the start date. Returns the value in the form of number of full days since [`nullDate`](../api/interfaces/configparams.md#nulldate).[^non-odff]', - parameters: [{name: 'Startdate', description: ''}, {name: 'Months', description: ''}], + parameters: [{name: 'start_date', description: ''}, {name: 'months', description: ''}], }, HOUR: { category: 'Date and time', shortDescription: 'Returns hour component of given time.', - parameters: [{name: 'Time', description: ''}], + parameters: [{name: 'time', description: ''}], }, INTERVAL: { category: 'Date and time', shortDescription: 'Returns interval string from given number of seconds.', - parameters: [{name: 'Seconds', description: ''}], + parameters: [{name: 'seconds', description: ''}], }, ISOWEEKNUM: { category: 'Date and time', shortDescription: 'Returns an ISO week number that corresponds to the week of year.', - parameters: [{name: 'Date', description: ''}], + parameters: [{name: 'date', description: ''}], }, MINUTE: { category: 'Date and time', shortDescription: 'Returns minute component of given time.', - parameters: [{name: 'Time', description: ''}], + parameters: [{name: 'time', description: ''}], }, MONTH: { category: 'Date and time', shortDescription: 'Returns the month for the given date value.', - parameters: [{name: 'Number', description: ''}], + parameters: [{name: 'number', description: ''}], }, NETWORKDAYS: { category: 'Date and time', shortDescription: 'Returns the number of working days between two given dates.', - parameters: [{name: 'Date1', description: ''}, {name: 'Date2', description: ''}, {name: 'Holidays', description: ''}], + parameters: [{name: 'date1', description: ''}, {name: 'date2', description: ''}, {name: 'holidays', description: ''}], }, 'NETWORKDAYS.INTL': { category: 'Date and time', shortDescription: 'Returns the number of working days between two given dates.', - parameters: [{name: 'Date1', description: ''}, {name: 'Date2', description: ''}, {name: 'Mode', description: ''}, {name: 'Holidays', description: ''}], + parameters: [{name: 'date1', description: ''}, {name: 'date2', description: ''}, {name: 'mode', description: ''}, {name: 'holidays', description: ''}], }, NOW: { category: 'Date and time', @@ -93,17 +93,17 @@ export const DATE_AND_TIME_DOCS: Record = { SECOND: { category: 'Date and time', shortDescription: 'Returns second component of given time.', - parameters: [{name: 'Time', description: ''}], + parameters: [{name: 'time', description: ''}], }, TIME: { category: 'Date and time', shortDescription: 'Returns the number that represents a given time as a fraction of full day.', - parameters: [{name: 'Hour', description: ''}, {name: 'Minute', description: ''}, {name: 'Second', description: ''}], + parameters: [{name: 'hour', description: ''}, {name: 'minute', description: ''}, {name: 'second', description: ''}], }, TIMEVALUE: { category: 'Date and time', shortDescription: 'Parses a time string and returns a number that represents it as a fraction of a full day.
Accepts formats set by the [`timeFormats`](../api/interfaces/configparams.md#timeformats) option.', - parameters: [{name: 'Timestring', description: ''}], + parameters: [{name: 'time_string', description: ''}], }, TODAY: { category: 'Date and time', @@ -113,31 +113,31 @@ export const DATE_AND_TIME_DOCS: Record = { WEEKDAY: { category: 'Date and time', shortDescription: 'Computes a number between 1-7 representing the day of week.', - parameters: [{name: 'Date', description: ''}, {name: 'Type', description: ''}], + parameters: [{name: 'date', description: ''}, {name: 'type', description: ''}], }, WEEKNUM: { category: 'Date and time', shortDescription: 'Returns a week number that corresponds to the week of year.', - parameters: [{name: 'Date', description: ''}, {name: 'Type', description: ''}], + parameters: [{name: 'date', description: ''}, {name: 'type', description: ''}], }, WORKDAY: { category: 'Date and time', shortDescription: 'Returns the working day number of days from start day.', - parameters: [{name: 'Date', description: ''}, {name: 'Shift', description: ''}, {name: 'Holidays', description: ''}], + parameters: [{name: 'date', description: ''}, {name: 'shift', description: ''}, {name: 'holidays', description: ''}], }, 'WORKDAY.INTL': { category: 'Date and time', shortDescription: 'Returns the working day number of days from start day.', - parameters: [{name: 'Date', description: ''}, {name: 'Shift', description: ''}, {name: 'Mode', description: ''}, {name: 'Holidays', description: ''}], + parameters: [{name: 'date', description: ''}, {name: 'shift', description: ''}, {name: 'mode', description: ''}, {name: 'holidays', description: ''}], }, YEAR: { category: 'Date and time', shortDescription: 'Returns the year as a number according to the internal calculation rules.', - parameters: [{name: 'Number', description: ''}], + parameters: [{name: 'number', description: ''}], }, YEARFRAC: { category: 'Date and time', shortDescription: 'Computes the difference between two date values, in fraction of years.', - parameters: [{name: 'Date2', description: ''}, {name: 'Date1', description: ''}, {name: 'Format', description: ''}], + parameters: [{name: 'date2', description: ''}, {name: 'date1', description: ''}, {name: 'format', description: ''}], }, } diff --git a/src/interpreter/functionMetadata/categories/engineering.ts b/src/interpreter/functionMetadata/categories/engineering.ts index d15ef5d67..eb15286fc 100644 --- a/src/interpreter/functionMetadata/categories/engineering.ts +++ b/src/interpreter/functionMetadata/categories/engineering.ts @@ -13,231 +13,231 @@ export const ENGINEERING_DOCS: Record = { BIN2DEC: { category: 'Engineering', shortDescription: 'The result is the decimal number for the binary number entered.', - parameters: [{name: 'Number', description: ''}], + parameters: [{name: 'number', description: ''}], }, BIN2HEX: { category: 'Engineering', shortDescription: 'The result is the hexadecimal number for the binary number entered.', - parameters: [{name: 'Number', description: ''}, {name: 'Places', description: ''}], + parameters: [{name: 'number', description: ''}, {name: 'places', description: ''}], }, BIN2OCT: { category: 'Engineering', shortDescription: 'The result is the octal number for the binary number entered.', - parameters: [{name: 'Number', description: ''}, {name: 'Places', description: ''}], + parameters: [{name: 'number', description: ''}, {name: 'places', description: ''}], }, BITAND: { category: 'Engineering', shortDescription: 'Returns a bitwise logical "and" of the parameters.', - parameters: [{name: 'Number1', description: ''}, {name: 'Number2', description: ''}], + parameters: [{name: 'number1', description: ''}, {name: 'number2', description: ''}], }, BITLSHIFT: { category: 'Engineering', shortDescription: 'Shifts a number left by n bits.', - parameters: [{name: 'Number', description: ''}, {name: 'Shift', description: ''}], + parameters: [{name: 'number', description: ''}, {name: 'shift', description: ''}], }, BITOR: { category: 'Engineering', shortDescription: 'Returns a bitwise logical "or" of the parameters.', - parameters: [{name: 'Number1', description: ''}, {name: 'Number2', description: ''}], + parameters: [{name: 'number1', description: ''}, {name: 'number2', description: ''}], }, BITRSHIFT: { category: 'Engineering', shortDescription: 'Shifts a number right by n bits.', - parameters: [{name: 'Number', description: ''}, {name: 'Shift', description: ''}], + parameters: [{name: 'number', description: ''}, {name: 'shift', description: ''}], }, BITXOR: { category: 'Engineering', shortDescription: 'Returns a bitwise logical "exclusive or" of the parameters.', - parameters: [{name: 'Number1', description: ''}, {name: 'Number2', description: ''}], + parameters: [{name: 'number1', description: ''}, {name: 'number2', description: ''}], }, COMPLEX: { category: 'Engineering', shortDescription: 'Returns complex number from Re and Im parts.', - parameters: [{name: 'Re', description: ''}, {name: 'Im', description: ''}, {name: 'Symbol', description: ''}], + parameters: [{name: 're', description: ''}, {name: 'im', description: ''}, {name: 'symbol', description: ''}], }, DEC2BIN: { category: 'Engineering', shortDescription: 'Returns the binary number for the decimal number entered between –512 and 511.', - parameters: [{name: 'Number', description: ''}, {name: 'Places', description: ''}], + parameters: [{name: 'number', description: ''}, {name: 'places', description: ''}], }, DEC2HEX: { category: 'Engineering', shortDescription: 'Returns the hexadecimal number for the decimal number entered.', - parameters: [{name: 'Number', description: ''}, {name: 'Places', description: ''}], + parameters: [{name: 'number', description: ''}, {name: 'places', description: ''}], }, DEC2OCT: { category: 'Engineering', shortDescription: 'Returns the octal number for the decimal number entered.', - parameters: [{name: 'Number', description: ''}, {name: 'Places', description: ''}], + parameters: [{name: 'number', description: ''}, {name: 'places', description: ''}], }, DELTA: { category: 'Engineering', shortDescription: 'Returns TRUE (1) if both numbers are equal, otherwise returns FALSE (0).', - parameters: [{name: 'Number_1', description: ''}, {name: 'Number_2', description: ''}], + parameters: [{name: 'number1', description: ''}, {name: 'number2', description: ''}], }, ERF: { category: 'Engineering', shortDescription: 'Returns values of the Gaussian error integral.', - parameters: [{name: 'Lower_Limit', description: ''}, {name: 'Upper_Limit', description: ''}], + parameters: [{name: 'lower_limit', description: ''}, {name: 'upper_limit', description: ''}], }, ERFC: { category: 'Engineering', shortDescription: 'Returns complementary values of the Gaussian error integral between x and infinity.', - parameters: [{name: 'Lower_Limit', description: ''}], + parameters: [{name: 'lower_limit', description: ''}], }, HEX2BIN: { category: 'Engineering', shortDescription: 'The result is the binary number for the hexadecimal number entered.', - parameters: [{name: 'Number', description: ''}, {name: 'Places', description: ''}], + parameters: [{name: 'number', description: ''}, {name: 'places', description: ''}], }, HEX2DEC: { category: 'Engineering', shortDescription: 'The result is the decimal number for the hexadecimal number entered.', - parameters: [{name: 'Number', description: ''}], + parameters: [{name: 'number', description: ''}], }, HEX2OCT: { category: 'Engineering', shortDescription: 'The result is the octal number for the hexadecimal number entered.', - parameters: [{name: 'Number', description: ''}, {name: 'Places', description: ''}], + parameters: [{name: 'number', description: ''}, {name: 'places', description: ''}], }, IMABS: { category: 'Engineering', shortDescription: 'Returns modulus of a complex number.', - parameters: [{name: 'Complex', description: ''}], + parameters: [{name: 'complex', description: ''}], }, IMAGINARY: { category: 'Engineering', shortDescription: 'Returns imaginary part of a complex number.', - parameters: [{name: 'Complex', description: ''}], + parameters: [{name: 'complex', description: ''}], }, IMARGUMENT: { category: 'Engineering', shortDescription: 'Returns argument of a complex number.', - parameters: [{name: 'Complex', description: ''}], + parameters: [{name: 'complex', description: ''}], }, IMCONJUGATE: { category: 'Engineering', shortDescription: 'Returns conjugate of a complex number.', - parameters: [{name: 'Complex', description: ''}], + parameters: [{name: 'complex', description: ''}], }, IMCOS: { category: 'Engineering', shortDescription: 'Returns cosine of a complex number.', - parameters: [{name: 'Complex', description: ''}], + parameters: [{name: 'complex', description: ''}], }, IMCOSH: { category: 'Engineering', shortDescription: 'Returns hyperbolic cosine of a complex number.', - parameters: [{name: 'Complex', description: ''}], + parameters: [{name: 'complex', description: ''}], }, IMCOT: { category: 'Engineering', shortDescription: 'Returns cotangent of a complex number.', - parameters: [{name: 'Complex', description: ''}], + parameters: [{name: 'complex', description: ''}], }, IMCSC: { category: 'Engineering', shortDescription: 'Returns cosecant of a complex number.', - parameters: [{name: 'Complex', description: ''}], + parameters: [{name: 'complex', description: ''}], }, IMCSCH: { category: 'Engineering', shortDescription: 'Returns hyperbolic cosecant of a complex number.', - parameters: [{name: 'Complex', description: ''}], + parameters: [{name: 'complex', description: ''}], }, IMDIV: { category: 'Engineering', shortDescription: 'Divides two complex numbers.', - parameters: [{name: 'Complex1', description: ''}, {name: 'Complex2', description: ''}], + parameters: [{name: 'complex1', description: ''}, {name: 'complex2', description: ''}], }, IMEXP: { category: 'Engineering', shortDescription: 'Returns exponent of a complex number.', - parameters: [{name: 'Complex', description: ''}], + parameters: [{name: 'complex', description: ''}], }, IMLN: { category: 'Engineering', shortDescription: 'Returns natural logarithm of a complex number.', - parameters: [{name: 'Complex', description: ''}], + parameters: [{name: 'complex', description: ''}], }, IMLOG10: { category: 'Engineering', shortDescription: 'Returns base-10 logarithm of a complex number.', - parameters: [{name: 'Complex', description: ''}], + parameters: [{name: 'complex', description: ''}], }, IMLOG2: { category: 'Engineering', shortDescription: 'Returns binary logarithm of a complex number.', - parameters: [{name: 'Complex', description: ''}], + parameters: [{name: 'complex', description: ''}], }, IMPOWER: { category: 'Engineering', shortDescription: 'Returns a complex number raised to a given power.', - parameters: [{name: 'Complex', description: ''}, {name: 'Number', description: ''}], + parameters: [{name: 'complex', description: ''}, {name: 'number', description: ''}], }, IMPRODUCT: { category: 'Engineering', shortDescription: 'Multiplies complex numbers.', - parameters: [{name: 'Complex1', description: ''}], + parameters: [{name: 'complex1', description: ''}], }, IMREAL: { category: 'Engineering', shortDescription: 'Returns real part of a complex number.', - parameters: [{name: 'Complex', description: ''}], + parameters: [{name: 'complex', description: ''}], }, IMSEC: { category: 'Engineering', shortDescription: 'Returns the secant of a complex number.', - parameters: [{name: 'Complex', description: ''}], + parameters: [{name: 'complex', description: ''}], }, IMSECH: { category: 'Engineering', shortDescription: 'Returns the hyperbolic secant of a complex number.', - parameters: [{name: 'Complex', description: ''}], + parameters: [{name: 'complex', description: ''}], }, IMSIN: { category: 'Engineering', shortDescription: 'Returns sine of a complex number.', - parameters: [{name: 'Complex', description: ''}], + parameters: [{name: 'complex', description: ''}], }, IMSINH: { category: 'Engineering', shortDescription: 'Returns hyperbolic sine of a complex number.', - parameters: [{name: 'Complex', description: ''}], + parameters: [{name: 'complex', description: ''}], }, IMSQRT: { category: 'Engineering', shortDescription: 'Returns a square root of a complex number.', - parameters: [{name: 'Complex', description: ''}], + parameters: [{name: 'complex', description: ''}], }, IMSUB: { category: 'Engineering', shortDescription: 'Subtracts two complex numbers.', - parameters: [{name: 'Complex1', description: ''}, {name: 'Complex2', description: ''}], + parameters: [{name: 'complex1', description: ''}, {name: 'complex2', description: ''}], }, IMSUM: { category: 'Engineering', shortDescription: 'Adds complex numbers.', - parameters: [{name: 'Complex1', description: ''}], + parameters: [{name: 'complex1', description: ''}], }, IMTAN: { category: 'Engineering', shortDescription: 'Returns the tangent of a complex number.', - parameters: [{name: 'Complex', description: ''}], + parameters: [{name: 'complex', description: ''}], }, OCT2BIN: { category: 'Engineering', shortDescription: 'The result is the binary number for the octal number entered.', - parameters: [{name: 'Number', description: ''}, {name: 'Places', description: ''}], + parameters: [{name: 'number', description: ''}, {name: 'places', description: ''}], }, OCT2DEC: { category: 'Engineering', shortDescription: 'The result is the decimal number for the octal number entered.', - parameters: [{name: 'Number', description: ''}], + parameters: [{name: 'number', description: ''}], }, OCT2HEX: { category: 'Engineering', shortDescription: 'The result is the hexadecimal number for the octal number entered.', - parameters: [{name: 'Number', description: ''}, {name: 'Places', description: ''}], + parameters: [{name: 'number', description: ''}, {name: 'places', description: ''}], }, } diff --git a/src/interpreter/functionMetadata/categories/financial.ts b/src/interpreter/functionMetadata/categories/financial.ts index 05244947a..c4cb31e5b 100644 --- a/src/interpreter/functionMetadata/categories/financial.ts +++ b/src/interpreter/functionMetadata/categories/financial.ts @@ -13,146 +13,146 @@ export const FINANCIAL_DOCS: Record = { CUMIPMT: { category: 'Financial', shortDescription: 'Returns the cumulative interest paid on a loan between a start period and an end period.', - parameters: [{name: 'Rate', description: ''}, {name: 'Nper', description: ''}, {name: 'Pv', description: ''}, {name: 'Start', description: ''}, {name: 'End', description: ''}, {name: 'Type', description: ''}], + parameters: [{name: 'rate', description: ''}, {name: 'nper', description: ''}, {name: 'pv', description: ''}, {name: 'start', description: ''}, {name: 'end', description: ''}, {name: 'type', description: ''}], }, CUMPRINC: { category: 'Financial', shortDescription: 'Returns the cumulative principal paid on a loan between a start period and an end period.', - parameters: [{name: 'Rate', description: ''}, {name: 'Nper', description: ''}, {name: 'Pv', description: ''}, {name: 'Start', description: ''}, {name: 'End', description: ''}, {name: 'Type', description: ''}], + parameters: [{name: 'rate', description: ''}, {name: 'nper', description: ''}, {name: 'pv', description: ''}, {name: 'start', description: ''}, {name: 'end', description: ''}, {name: 'type', description: ''}], }, DB: { category: 'Financial', shortDescription: 'Returns the depreciation of an asset for a period using the fixed-declining balance method.', - parameters: [{name: 'Cost', description: ''}, {name: 'Salvage', description: ''}, {name: 'Life', description: ''}, {name: 'Period', description: ''}, {name: 'Month', description: ''}], + parameters: [{name: 'cost', description: ''}, {name: 'salvage', description: ''}, {name: 'life', description: ''}, {name: 'period', description: ''}, {name: 'month', description: ''}], }, DDB: { category: 'Financial', shortDescription: 'Returns the depreciation of an asset for a period using the double-declining balance method.', - parameters: [{name: 'Cost', description: ''}, {name: 'Salvage', description: ''}, {name: 'Life', description: ''}, {name: 'Period', description: ''}, {name: 'Factor', description: ''}], + parameters: [{name: 'cost', description: ''}, {name: 'salvage', description: ''}, {name: 'life', description: ''}, {name: 'period', description: ''}, {name: 'factor', description: ''}], }, DOLLARDE: { category: 'Financial', shortDescription: 'Converts a price entered with a special notation to a price displayed as a decimal number.', - parameters: [{name: 'Price', description: ''}, {name: 'Fraction', description: ''}], + parameters: [{name: 'price', description: ''}, {name: 'fraction', description: ''}], }, DOLLARFR: { category: 'Financial', shortDescription: 'Converts a price displayed as a decimal number to a price entered with a special notation.', - parameters: [{name: 'Price', description: ''}, {name: 'Fraction', description: ''}], + parameters: [{name: 'price', description: ''}, {name: 'fraction', description: ''}], }, EFFECT: { category: 'Financial', shortDescription: 'Calculates the effective annual interest rate from a nominal interest rate and the number of compounding periods per year.', - parameters: [{name: 'Nominal_rate', description: ''}, {name: 'Npery', description: ''}], + parameters: [{name: 'nominal_rate', description: ''}, {name: 'npery', description: ''}], }, FV: { category: 'Financial', shortDescription: 'Returns the future value of an investment.', - parameters: [{name: 'Rate', description: ''}, {name: 'Nper', description: ''}, {name: 'Pmt', description: ''}, {name: 'Pv', description: ''}, {name: 'Type', description: ''}], + parameters: [{name: 'rate', description: ''}, {name: 'nper', description: ''}, {name: 'pmt', description: ''}, {name: 'pv', description: ''}, {name: 'type', description: ''}], }, FVSCHEDULE: { category: 'Financial', shortDescription: 'Returns the future value of an investment based on a rate schedule.', - parameters: [{name: 'Pv', description: ''}, {name: 'Schedule', description: ''}], + parameters: [{name: 'pv', description: ''}, {name: 'schedule', description: ''}], }, IPMT: { category: 'Financial', shortDescription: 'Returns the interest portion of a given loan payment in a given payment period.', - parameters: [{name: 'Rate', description: ''}, {name: 'Per', description: ''}, {name: 'Nper', description: ''}, {name: 'Pv', description: ''}, {name: 'Fv', description: ''}, {name: 'Type', description: ''}], + parameters: [{name: 'rate', description: ''}, {name: 'per', description: ''}, {name: 'nper', description: ''}, {name: 'pv', description: ''}, {name: 'fv', description: ''}, {name: 'type', description: ''}], }, IRR: { category: 'Financial', shortDescription: 'Returns the internal rate of return for a series of cash flows.', - parameters: [{name: 'Values', description: ''}, {name: 'Guess', description: ''}], + parameters: [{name: 'values', description: ''}, {name: 'guess', description: ''}], }, ISPMT: { category: 'Financial', shortDescription: 'Returns the interest paid for a given period of an investment with equal principal payments.', - parameters: [{name: 'Rate', description: ''}, {name: 'Per', description: ''}, {name: 'Nper', description: ''}, {name: 'Value', description: ''}], + parameters: [{name: 'rate', description: ''}, {name: 'per', description: ''}, {name: 'nper', description: ''}, {name: 'value', description: ''}], }, MIRR: { category: 'Financial', shortDescription: 'Returns modified internal value for cashflows.', - parameters: [{name: 'Flows', description: ''}, {name: 'FRate', description: ''}, {name: 'RRate', description: ''}], + parameters: [{name: 'flows', description: ''}, {name: 'f_rate', description: ''}, {name: 'r_rate', description: ''}], }, NOMINAL: { category: 'Financial', shortDescription: 'Returns the nominal interest rate.', - parameters: [{name: 'Effect_rate', description: ''}, {name: 'Npery', description: ''}], + parameters: [{name: 'effect_rate', description: ''}, {name: 'npery', description: ''}], }, NPER: { category: 'Financial', shortDescription: 'Returns the number of periods for an investment assuming periodic, constant payments and a constant interest rate.', - parameters: [{name: 'Rate', description: ''}, {name: 'Pmt', description: ''}, {name: 'Pv', description: ''}, {name: 'Fv', description: ''}, {name: 'Type', description: ''}], + parameters: [{name: 'rate', description: ''}, {name: 'pmt', description: ''}, {name: 'pv', description: ''}, {name: 'fv', description: ''}, {name: 'type', description: ''}], }, NPV: { category: 'Financial', shortDescription: 'Returns net present value.', - parameters: [{name: 'Rate', description: ''}, {name: 'Value1', description: ''}], + parameters: [{name: 'rate', description: ''}, {name: 'value1', description: ''}], }, PDURATION: { category: 'Financial', shortDescription: 'Returns number of periods to reach specific value.', - parameters: [{name: 'Rate', description: ''}, {name: 'Pv', description: ''}, {name: 'Fv', description: ''}], + parameters: [{name: 'rate', description: ''}, {name: 'pv', description: ''}, {name: 'fv', description: ''}], }, PMT: { category: 'Financial', shortDescription: 'Returns the periodic payment for a loan.', - parameters: [{name: 'Rate', description: ''}, {name: 'Nper', description: ''}, {name: 'Pv', description: ''}, {name: 'Fv', description: ''}, {name: 'Type', description: ''}], + parameters: [{name: 'rate', description: ''}, {name: 'nper', description: ''}, {name: 'pv', description: ''}, {name: 'fv', description: ''}, {name: 'type', description: ''}], }, PPMT: { category: 'Financial', shortDescription: 'Calculates the principal portion of a given loan payment.', - parameters: [{name: 'Rate', description: ''}, {name: 'Per', description: ''}, {name: 'Nper', description: ''}, {name: 'Pv', description: ''}, {name: 'Fv', description: ''}, {name: 'Type', description: ''}], + parameters: [{name: 'rate', description: ''}, {name: 'per', description: ''}, {name: 'nper', description: ''}, {name: 'pv', description: ''}, {name: 'fv', description: ''}, {name: 'type', description: ''}], }, PV: { category: 'Financial', shortDescription: 'Returns the present value of an investment.', - parameters: [{name: 'Rate', description: ''}, {name: 'Nper', description: ''}, {name: 'Pmt', description: ''}, {name: 'Fv', description: ''}, {name: 'Type', description: ''}], + parameters: [{name: 'rate', description: ''}, {name: 'nper', description: ''}, {name: 'pmt', description: ''}, {name: 'fv', description: ''}, {name: 'type', description: ''}], }, RATE: { category: 'Financial', shortDescription: 'Returns the interest rate per period of an annuity.', - parameters: [{name: 'Nper', description: ''}, {name: 'Pmt', description: ''}, {name: 'Pv', description: ''}, {name: 'Fv', description: ''}, {name: 'Type', description: ''}, {name: 'Guess', description: ''}], + parameters: [{name: 'nper', description: ''}, {name: 'pmt', description: ''}, {name: 'pv', description: ''}, {name: 'fv', description: ''}, {name: 'type', description: ''}, {name: 'guess', description: ''}], }, RRI: { category: 'Financial', shortDescription: 'Returns an equivalent interest rate for the growth of an investment.', - parameters: [{name: 'Nper', description: ''}, {name: 'Pv', description: ''}, {name: 'Fv', description: ''}], + parameters: [{name: 'nper', description: ''}, {name: 'pv', description: ''}, {name: 'fv', description: ''}], }, SLN: { category: 'Financial', shortDescription: 'Returns the depreciation of an asset for one period, based on a straight-line method.', - parameters: [{name: 'Cost', description: ''}, {name: 'Salvage', description: ''}, {name: 'Life', description: ''}], + parameters: [{name: 'cost', description: ''}, {name: 'salvage', description: ''}, {name: 'life', description: ''}], }, SYD: { category: 'Financial', shortDescription: 'Returns the "sum-of-years" depreciation for an asset in a period.', - parameters: [{name: 'Cost', description: ''}, {name: 'Salvage', description: ''}, {name: 'Life', description: ''}, {name: 'Period', description: ''}], + parameters: [{name: 'cost', description: ''}, {name: 'salvage', description: ''}, {name: 'life', description: ''}, {name: 'period', description: ''}], }, TBILLEQ: { category: 'Financial', shortDescription: 'Returns the bond-equivalent yield for a Treasury bill.', - parameters: [{name: 'Settlement', description: ''}, {name: 'Maturity', description: ''}, {name: 'Discount', description: ''}], + parameters: [{name: 'settlement', description: ''}, {name: 'maturity', description: ''}, {name: 'discount', description: ''}], }, TBILLPRICE: { category: 'Financial', shortDescription: 'Returns the price per $100 face value for a Treasury bill.', - parameters: [{name: 'Settlement', description: ''}, {name: 'Maturity', description: ''}, {name: 'Discount', description: ''}], + parameters: [{name: 'settlement', description: ''}, {name: 'maturity', description: ''}, {name: 'discount', description: ''}], }, TBILLYIELD: { category: 'Financial', shortDescription: 'Returns the yield for a Treasury bill.', - parameters: [{name: 'Settlement', description: ''}, {name: 'Maturity', description: ''}, {name: 'Price', description: ''}], + parameters: [{name: 'settlement', description: ''}, {name: 'maturity', description: ''}, {name: 'price', description: ''}], }, XNPV: { category: 'Financial', shortDescription: 'Returns net present value.', - parameters: [{name: 'Rate', description: ''}, {name: 'Payments', description: ''}, {name: 'Dates', description: ''}], + parameters: [{name: 'rate', description: ''}, {name: 'payments', description: ''}, {name: 'dates', description: ''}], }, XIRR: { category: 'Financial', shortDescription: 'Returns the internal rate of return for a schedule of cash flows that is not necessarily periodic.', - parameters: [{name: 'Values', description: ''}, {name: 'Dates', description: ''}, {name: 'Guess', description: ''}], + parameters: [{name: 'values', description: ''}, {name: 'dates', description: ''}, {name: 'guess', description: ''}], }, } diff --git a/src/interpreter/functionMetadata/categories/information.ts b/src/interpreter/functionMetadata/categories/information.ts index ab12675e7..1799f73a6 100644 --- a/src/interpreter/functionMetadata/categories/information.ts +++ b/src/interpreter/functionMetadata/categories/information.ts @@ -13,67 +13,67 @@ export const INFORMATION_DOCS: Record = { ISBINARY: { category: 'Information', shortDescription: 'Returns TRUE if provided value is a valid binary number.', - parameters: [{name: 'Value', description: ''}], + parameters: [{name: 'value', description: ''}], }, ISBLANK: { category: 'Information', shortDescription: 'Returns TRUE if the reference to a cell is blank.', - parameters: [{name: 'Value', description: ''}], + parameters: [{name: 'value', description: ''}], }, ISERR: { category: 'Information', shortDescription: 'Returns TRUE if the value is error value except #N/A!.', - parameters: [{name: 'Value', description: ''}], + parameters: [{name: 'value', description: ''}], }, ISERROR: { category: 'Information', shortDescription: 'Returns TRUE if the value is general error value.', - parameters: [{name: 'Value', description: ''}], + parameters: [{name: 'value', description: ''}], }, ISEVEN: { category: 'Information', shortDescription: 'Returns TRUE if the value is an even integer, or FALSE if the value is odd.', - parameters: [{name: 'Value', description: ''}], + parameters: [{name: 'value', description: ''}], }, ISFORMULA: { category: 'Information', shortDescription: 'Checks whether referenced cell is a formula.', - parameters: [{name: 'Value', description: ''}], + parameters: [{name: 'value', description: ''}], }, ISLOGICAL: { category: 'Information', shortDescription: 'Tests for a logical value (TRUE or FALSE).', - parameters: [{name: 'Value', description: ''}], + parameters: [{name: 'value', description: ''}], }, ISNA: { category: 'Information', shortDescription: 'Returns TRUE if the value is #N/A! error.', - parameters: [{name: 'Value', description: ''}], + parameters: [{name: 'value', description: ''}], }, ISNONTEXT: { category: 'Information', shortDescription: 'Tests if the cell contents are text or numbers, and returns FALSE if the contents are text.', - parameters: [{name: 'Value', description: ''}], + parameters: [{name: 'value', description: ''}], }, ISNUMBER: { category: 'Information', shortDescription: 'Returns TRUE if the value refers to a number.', - parameters: [{name: 'Value', description: ''}], + parameters: [{name: 'value', description: ''}], }, ISODD: { category: 'Information', shortDescription: 'Returns TRUE if the value is odd, or FALSE if the number is even.', - parameters: [{name: 'Value', description: ''}], + parameters: [{name: 'value', description: ''}], }, ISREF: { category: 'Information', shortDescription: 'Returns TRUE if provided value is #REF! error.', - parameters: [{name: 'Value', description: ''}], + parameters: [{name: 'value', description: ''}], }, ISTEXT: { category: 'Information', shortDescription: 'Returns TRUE if the cell contents reference text.', - parameters: [{name: 'Value', description: ''}], + parameters: [{name: 'value', description: ''}], }, NA: { category: 'Information', @@ -83,11 +83,11 @@ export const INFORMATION_DOCS: Record = { SHEET: { category: 'Information', shortDescription: 'Returns sheet number of a given value or a formula sheet number if no argument is provided.', - parameters: [{name: 'Value', description: ''}], + parameters: [{name: 'value', description: ''}], }, SHEETS: { category: 'Information', shortDescription: 'Returns number of sheet of a given reference or number of all sheets in workbook when no argument is provided.', - parameters: [{name: 'Value', description: ''}], + parameters: [{name: 'value', description: ''}], }, } diff --git a/src/interpreter/functionMetadata/categories/logical.ts b/src/interpreter/functionMetadata/categories/logical.ts index b9e2e86c0..87a20b9ec 100644 --- a/src/interpreter/functionMetadata/categories/logical.ts +++ b/src/interpreter/functionMetadata/categories/logical.ts @@ -13,7 +13,7 @@ export const LOGICAL_DOCS: Record = { AND: { category: 'Logical', shortDescription: 'Returns TRUE if all arguments are TRUE.', - parameters: [{name: 'Logical_value1', description: ''}], + parameters: [{name: 'logical_value1', description: ''}], }, FALSE: { category: 'Logical', @@ -23,37 +23,37 @@ export const LOGICAL_DOCS: Record = { IF: { category: 'Logical', shortDescription: 'Specifies a logical test to be performed.', - parameters: [{name: 'Test', description: ''}, {name: 'Then_value', description: ''}, {name: 'Otherwise_value', description: ''}], + parameters: [{name: 'test', description: ''}, {name: 'then_value', description: ''}, {name: 'otherwise_value', description: ''}], }, IFERROR: { category: 'Logical', shortDescription: 'Returns the value if the cell does not contains an error value, or the alternative value if it does.', - parameters: [{name: 'Value', description: ''}, {name: 'Alternate_value', description: ''}], + parameters: [{name: 'value', description: ''}, {name: 'alternate_value', description: ''}], }, IFNA: { category: 'Logical', shortDescription: 'Returns the value if the cell does not contains the #N/A (value not available) error value, or the alternative value if it does.', - parameters: [{name: 'Value', description: ''}, {name: 'Alternate_value', description: ''}], + parameters: [{name: 'value', description: ''}, {name: 'alternate_value', description: ''}], }, IFS: { category: 'Logical', shortDescription: 'Evaluates multiple logical tests and returns a value that corresponds to the first true condition.', - parameters: [{name: 'Condition1', description: ''}, {name: 'Value1', description: ''}], + parameters: [{name: 'condition1', description: ''}, {name: 'value1', description: ''}], }, NOT: { category: 'Logical', shortDescription: 'Complements (inverts) a logical value.', - parameters: [{name: 'Logicalvalue', description: ''}], + parameters: [{name: 'logical_value', description: ''}], }, OR: { category: 'Logical', shortDescription: 'Returns TRUE if at least one argument is TRUE.', - parameters: [{name: 'Logical_value1', description: ''}], + parameters: [{name: 'logical_value1', description: ''}], }, SWITCH: { category: 'Logical', shortDescription: 'Evaluates a list of arguments, consisting of an expression followed by a value.', - parameters: [{name: 'Expression1', description: ''}, {name: 'Value1', description: ''}, {name: 'Expression2', description: ''}], + parameters: [{name: 'expression1', description: ''}, {name: 'value1', description: ''}, {name: 'expression2', description: ''}], }, TRUE: { category: 'Logical', @@ -63,6 +63,6 @@ export const LOGICAL_DOCS: Record = { XOR: { category: 'Logical', shortDescription: 'Returns true if an odd number of arguments evaluates to TRUE.', - parameters: [{name: 'Logical_value1', description: ''}], + parameters: [{name: 'logical_value1', description: ''}], }, } diff --git a/src/interpreter/functionMetadata/categories/lookup-and-reference.ts b/src/interpreter/functionMetadata/categories/lookup-and-reference.ts index a1b491563..456e76265 100644 --- a/src/interpreter/functionMetadata/categories/lookup-and-reference.ts +++ b/src/interpreter/functionMetadata/categories/lookup-and-reference.ts @@ -13,66 +13,66 @@ export const LOOKUP_AND_REFERENCE_DOCS: Record = { ADDRESS: { category: 'Lookup and reference', shortDescription: 'Returns a cell reference as a string.', - parameters: [{name: 'Row', description: ''}, {name: 'Column', description: ''}, {name: 'AbsoluteRelativeMode', description: ''}, {name: 'UseA1Notation', description: ''}, {name: 'Sheet', description: ''}], + parameters: [{name: 'row', description: ''}, {name: 'column', description: ''}, {name: 'absolute_relative_mode', description: ''}, {name: 'use_a1_notation', description: ''}, {name: 'sheet', description: ''}], }, CHOOSE: { category: 'Lookup and reference', shortDescription: 'Uses an index to return a value from a list of values.', - parameters: [{name: 'Index', description: ''}, {name: 'Value1', description: ''}], + parameters: [{name: 'index', description: ''}, {name: 'value1', description: ''}], }, COLUMN: { category: 'Lookup and reference', shortDescription: 'Returns column number of a given reference or formula reference if argument not provided.', - parameters: [{name: 'Reference', description: ''}], + parameters: [{name: 'reference', description: ''}], }, COLUMNS: { category: 'Lookup and reference', shortDescription: 'Returns the number of columns in the given reference.', - parameters: [{name: 'Array', description: ''}], + parameters: [{name: 'array', description: ''}], }, FORMULATEXT: { category: 'Lookup and reference', shortDescription: 'Returns a formula in a given cell as a string.', - parameters: [{name: 'Reference', description: ''}], + parameters: [{name: 'reference', description: ''}], }, HLOOKUP: { category: 'Lookup and reference', shortDescription: 'Searches horizontally with reference to adjacent cells to the bottom.', - parameters: [{name: 'Search_Criterion', description: ''}, {name: 'Array', description: ''}, {name: 'Index', description: ''}, {name: 'Sort_Order', description: ''}], + parameters: [{name: 'search_criterion', description: ''}, {name: 'array', description: ''}, {name: 'index', description: ''}, {name: 'sort_order', description: ''}], }, HYPERLINK: { category: 'Lookup and reference', shortDescription: 'Stores the url in the cell\'s metadata. It can be read using method [`getCellHyperlink`](../api/classes/hyperformula.md#getcellhyperlink)', - parameters: [{name: 'Url', description: ''}, {name: 'LinkLabel', description: ''}], + parameters: [{name: 'url', description: ''}, {name: 'link_label', description: ''}], }, INDEX: { category: 'Lookup and reference', shortDescription: 'Returns the contents of a cell specified by row and column number. The column number is optional and defaults to 1.', - parameters: [{name: 'Range', description: ''}, {name: 'Row', description: ''}, {name: 'Column', description: ''}], + parameters: [{name: 'range', description: ''}, {name: 'row', description: ''}, {name: 'column', description: ''}], }, MATCH: { category: 'Lookup and reference', shortDescription: 'Returns the relative position of an item in an array that matches a specified value.', - parameters: [{name: 'Searchcriterion', description: ''}, {name: 'LookupArray', description: ''}, {name: 'MatchType', description: ''}], + parameters: [{name: 'search_criterion', description: ''}, {name: 'lookup_array', description: ''}, {name: 'match_type', description: ''}], }, ROW: { category: 'Lookup and reference', shortDescription: 'Returns row number of a given reference or formula reference if argument not provided.', - parameters: [{name: 'Reference', description: ''}], + parameters: [{name: 'reference', description: ''}], }, ROWS: { category: 'Lookup and reference', shortDescription: 'Returns the number of rows in the given reference.', - parameters: [{name: 'Array', description: ''}], + parameters: [{name: 'array', description: ''}], }, VLOOKUP: { category: 'Lookup and reference', shortDescription: 'Searches vertically with reference to adjacent cells to the right.', - parameters: [{name: 'Search_Criterion', description: ''}, {name: 'Array', description: ''}, {name: 'Index', description: ''}, {name: 'Sort_Order', description: ''}], + parameters: [{name: 'search_criterion', description: ''}, {name: 'array', description: ''}, {name: 'index', description: ''}, {name: 'sort_order', description: ''}], }, XLOOKUP: { category: 'Lookup and reference', shortDescription: 'Searches for a key in a range and returns the item corresponding to the match it finds. If no match exists, then XLOOKUP can return the closest (approximate) match.', - parameters: [{name: 'LookupValue', description: ''}, {name: 'LookupArray', description: ''}, {name: 'ReturnArray', description: ''}, {name: 'IfNotFound', description: ''}, {name: 'MatchMode', description: ''}, {name: 'SearchMode', description: ''}], + parameters: [{name: 'lookup_value', description: ''}, {name: 'lookup_array', description: ''}, {name: 'return_array', description: ''}, {name: 'if_not_found', description: ''}, {name: 'match_mode', description: ''}, {name: 'search_mode', description: ''}], }, } diff --git a/src/interpreter/functionMetadata/categories/math-and-trigonometry.ts b/src/interpreter/functionMetadata/categories/math-and-trigonometry.ts index 4ebb5f1fb..008202a50 100644 --- a/src/interpreter/functionMetadata/categories/math-and-trigonometry.ts +++ b/src/interpreter/functionMetadata/categories/math-and-trigonometry.ts @@ -13,217 +13,217 @@ export const MATH_AND_TRIGONOMETRY_DOCS: Record = { ABS: { category: 'Math and trigonometry', shortDescription: 'Returns the absolute value of a number.', - parameters: [{name: 'Number', description: ''}], + parameters: [{name: 'number', description: ''}], }, ACOS: { category: 'Math and trigonometry', shortDescription: 'Returns the inverse trigonometric cosine of a number.', - parameters: [{name: 'Number', description: ''}], + parameters: [{name: 'number', description: ''}], }, ACOSH: { category: 'Math and trigonometry', shortDescription: 'Returns the inverse hyperbolic cosine of a number.', - parameters: [{name: 'Number', description: ''}], + parameters: [{name: 'number', description: ''}], }, ACOT: { category: 'Math and trigonometry', shortDescription: 'Returns the inverse trigonometric cotangent of a number.', - parameters: [{name: 'Number', description: ''}], + parameters: [{name: 'number', description: ''}], }, ACOTH: { category: 'Math and trigonometry', shortDescription: 'Returns the inverse hyperbolic cotangent of a number.', - parameters: [{name: 'Number', description: ''}], + parameters: [{name: 'number', description: ''}], }, ARABIC: { category: 'Math and trigonometry', shortDescription: 'Converts number from roman form.', - parameters: [{name: 'String', description: ''}], + parameters: [{name: 'string', description: ''}], }, ASIN: { category: 'Math and trigonometry', shortDescription: 'Returns the inverse trigonometric sine of a number.', - parameters: [{name: 'Number', description: ''}], + parameters: [{name: 'number', description: ''}], }, ASINH: { category: 'Math and trigonometry', shortDescription: 'Returns the inverse hyperbolic sine of a number.', - parameters: [{name: 'Number', description: ''}], + parameters: [{name: 'number', description: ''}], }, ATAN: { category: 'Math and trigonometry', shortDescription: 'Returns the inverse trigonometric tangent of a number.', - parameters: [{name: 'Number', description: ''}], + parameters: [{name: 'number', description: ''}], }, ATAN2: { category: 'Math and trigonometry', shortDescription: 'Returns the inverse trigonometric tangent of the specified x and y coordinates.', - parameters: [{name: 'Numberx', description: ''}, {name: 'Numbery', description: ''}], + parameters: [{name: 'number_x', description: ''}, {name: 'number_y', description: ''}], }, ATANH: { category: 'Math and trigonometry', shortDescription: 'Returns the inverse hyperbolic tangent of a number.', - parameters: [{name: 'Number', description: ''}], + parameters: [{name: 'number', description: ''}], }, BASE: { category: 'Math and trigonometry', shortDescription: 'Converts a positive integer to a specified base into a text from the numbering system.', - parameters: [{name: 'Number', description: ''}, {name: 'Radix', description: ''}, {name: 'Minimumlength', description: ''}], + parameters: [{name: 'number', description: ''}, {name: 'radix', description: ''}, {name: 'minimum_length', description: ''}], }, CEILING: { category: 'Math and trigonometry', shortDescription: 'Rounds a number up to the nearest multiple of Significance.', - parameters: [{name: 'Number', description: ''}, {name: 'Significance', description: ''}], + parameters: [{name: 'number', description: ''}, {name: 'significance', description: ''}], }, 'CEILING.MATH': { category: 'Math and trigonometry', shortDescription: 'Rounds a number up to the nearest multiple of Significance.', - parameters: [{name: 'Number', description: ''}, {name: 'Significance', description: ''}, {name: 'Mode', description: ''}], + parameters: [{name: 'number', description: ''}, {name: 'significance', description: ''}, {name: 'mode', description: ''}], }, 'CEILING.PRECISE': { category: 'Math and trigonometry', shortDescription: 'Rounds a number up to the nearest multiple of Significance.', - parameters: [{name: 'Number', description: ''}, {name: 'Significance', description: ''}], + parameters: [{name: 'number', description: ''}, {name: 'significance', description: ''}], }, COMBIN: { category: 'Math and trigonometry', shortDescription: 'Returns number of combinations (without repetitions).', - parameters: [{name: 'Number1', description: ''}, {name: 'Number2', description: ''}], + parameters: [{name: 'number1', description: ''}, {name: 'number2', description: ''}], }, COMBINA: { category: 'Math and trigonometry', shortDescription: 'Returns number of combinations (with repetitions).', - parameters: [{name: 'Number1', description: ''}, {name: 'Number2', description: ''}], + parameters: [{name: 'number1', description: ''}, {name: 'number2', description: ''}], }, COS: { category: 'Math and trigonometry', shortDescription: 'Returns the cosine of the given angle (in radians).', - parameters: [{name: 'Number', description: ''}], + parameters: [{name: 'number', description: ''}], }, COSH: { category: 'Math and trigonometry', shortDescription: 'Returns the hyperbolic cosine of the given value.', - parameters: [{name: 'Number', description: ''}], + parameters: [{name: 'number', description: ''}], }, COT: { category: 'Math and trigonometry', shortDescription: 'Returns the cotangent of the given angle (in radians).', - parameters: [{name: 'Number', description: ''}], + parameters: [{name: 'number', description: ''}], }, COTH: { category: 'Math and trigonometry', shortDescription: 'Returns the hyperbolic cotangent of the given value.', - parameters: [{name: 'Number', description: ''}], + parameters: [{name: 'number', description: ''}], }, COUNTUNIQUE: { category: 'Math and trigonometry', shortDescription: 'Counts the number of unique values in a list of specified values and ranges.', - parameters: [{name: 'Value1', description: ''}], + parameters: [{name: 'value1', description: ''}], }, CSC: { category: 'Math and trigonometry', shortDescription: 'Returns the cosecant of the given angle (in radians).', - parameters: [{name: 'Number', description: ''}], + parameters: [{name: 'number', description: ''}], }, CSCH: { category: 'Math and trigonometry', shortDescription: 'Returns the hyperbolic cosecant of the given value.', - parameters: [{name: 'Number', description: ''}], + parameters: [{name: 'number', description: ''}], }, DECIMAL: { category: 'Math and trigonometry', shortDescription: 'Converts text with characters from a number system to a positive integer in the base radix given.', - parameters: [{name: 'Text', description: ''}, {name: 'Radix', description: ''}], + parameters: [{name: 'text', description: ''}, {name: 'radix', description: ''}], }, DEGREES: { category: 'Math and trigonometry', shortDescription: 'Converts radians into degrees.', - parameters: [{name: 'Number', description: ''}], + parameters: [{name: 'number', description: ''}], }, EVEN: { category: 'Math and trigonometry', shortDescription: 'Rounds a positive number up to the next even integer and a negative number down to the next even integer.', - parameters: [{name: 'Number', description: ''}], + parameters: [{name: 'number', description: ''}], }, EXP: { category: 'Math and trigonometry', shortDescription: 'Returns constant e raised to the power of a number.', - parameters: [{name: 'Number', description: ''}], + parameters: [{name: 'number', description: ''}], }, FACT: { category: 'Math and trigonometry', shortDescription: 'Returns a factorial of a number.', - parameters: [{name: 'Number', description: ''}], + parameters: [{name: 'number', description: ''}], }, FACTDOUBLE: { category: 'Math and trigonometry', shortDescription: 'Returns a double factorial of a number.', - parameters: [{name: 'Number', description: ''}], + parameters: [{name: 'number', description: ''}], }, FLOOR: { category: 'Math and trigonometry', shortDescription: 'Rounds a number down to the nearest multiple of Significance.', - parameters: [{name: 'Number', description: ''}, {name: 'Significance', description: ''}], + parameters: [{name: 'number', description: ''}, {name: 'significance', description: ''}], }, 'FLOOR.MATH': { category: 'Math and trigonometry', shortDescription: 'Rounds a number down to the nearest multiple of Significance.', - parameters: [{name: 'Number', description: ''}, {name: 'Significance', description: ''}, {name: 'Mode', description: ''}], + parameters: [{name: 'number', description: ''}, {name: 'significance', description: ''}, {name: 'mode', description: ''}], }, 'FLOOR.PRECISE': { category: 'Math and trigonometry', shortDescription: 'Rounds a number down to the nearest multiple of Significance.', - parameters: [{name: 'Number', description: ''}, {name: 'Significance', description: ''}], + parameters: [{name: 'number', description: ''}, {name: 'significance', description: ''}], }, GCD: { category: 'Math and trigonometry', shortDescription: 'Computes greatest common divisor of numbers.', - parameters: [{name: 'Number1', description: ''}], + parameters: [{name: 'number1', description: ''}], }, INT: { category: 'Math and trigonometry', shortDescription: 'Rounds a number down to the nearest integer.', - parameters: [{name: 'Number', description: ''}], + parameters: [{name: 'number', description: ''}], }, LCM: { category: 'Math and trigonometry', shortDescription: 'Computes least common multiple of numbers.', - parameters: [{name: 'Number1', description: ''}], + parameters: [{name: 'number1', description: ''}], }, LN: { category: 'Math and trigonometry', shortDescription: 'Returns the natural logarithm based on the constant e of a number.', - parameters: [{name: 'Number', description: ''}], + parameters: [{name: 'number', description: ''}], }, LOG: { category: 'Math and trigonometry', shortDescription: 'Returns the logarithm of a number to the specified base.', - parameters: [{name: 'Number', description: ''}, {name: 'Base', description: ''}], + parameters: [{name: 'number', description: ''}, {name: 'base', description: ''}], }, LOG10: { category: 'Math and trigonometry', shortDescription: 'Returns the base-10 logarithm of a number.', - parameters: [{name: 'Number', description: ''}], + parameters: [{name: 'number', description: ''}], }, MOD: { category: 'Math and trigonometry', shortDescription: 'Returns the remainder when one integer is divided by another.', - parameters: [{name: 'Dividend', description: ''}, {name: 'Divisor', description: ''}], + parameters: [{name: 'dividend', description: ''}, {name: 'divisor', description: ''}], }, MROUND: { category: 'Math and trigonometry', shortDescription: 'Rounds number to the neares multiplicity.', - parameters: [{name: 'Number', description: ''}, {name: 'Base', description: ''}], + parameters: [{name: 'number', description: ''}, {name: 'base', description: ''}], }, MULTINOMIAL: { category: 'Math and trigonometry', shortDescription: 'Returns number of multiset combinations.', - parameters: [{name: 'Number1', description: ''}], + parameters: [{name: 'number1', description: ''}], }, ODD: { category: 'Math and trigonometry', shortDescription: 'Rounds a positive number up to the nearest odd integer and a negative number down to the nearest odd integer.', - parameters: [{name: 'Number', description: ''}], + parameters: [{name: 'number', description: ''}], }, PI: { category: 'Math and trigonometry', @@ -233,22 +233,22 @@ export const MATH_AND_TRIGONOMETRY_DOCS: Record = { POWER: { category: 'Math and trigonometry', shortDescription: 'Returns a number raised to another number.', - parameters: [{name: 'Base', description: ''}, {name: 'Exponent', description: ''}], + parameters: [{name: 'base', description: ''}, {name: 'exponent', description: ''}], }, PRODUCT: { category: 'Math and trigonometry', shortDescription: 'Returns product of numbers.', - parameters: [{name: 'Number1', description: ''}], + parameters: [{name: 'number1', description: ''}], }, QUOTIENT: { category: 'Math and trigonometry', shortDescription: 'Returns integer part of a division.', - parameters: [{name: 'Dividend', description: ''}, {name: 'Divisor', description: ''}], + parameters: [{name: 'dividend', description: ''}, {name: 'divisor', description: ''}], }, RADIANS: { category: 'Math and trigonometry', shortDescription: 'Converts degrees to radians.', - parameters: [{name: 'Number', description: ''}], + parameters: [{name: 'number', description: ''}], }, RAND: { category: 'Math and trigonometry', @@ -258,72 +258,72 @@ export const MATH_AND_TRIGONOMETRY_DOCS: Record = { RANDBETWEEN: { category: 'Math and trigonometry', shortDescription: 'Returns a random integer between two numbers.', - parameters: [{name: 'Lowerbound', description: ''}, {name: 'Upperbound', description: ''}], + parameters: [{name: 'lower_bound', description: ''}, {name: 'upper_bound', description: ''}], }, ROMAN: { category: 'Math and trigonometry', shortDescription: 'Converts number to roman form.', - parameters: [{name: 'Number', description: ''}, {name: 'Mode', description: ''}], + parameters: [{name: 'number', description: ''}, {name: 'mode', description: ''}], }, ROUND: { category: 'Math and trigonometry', shortDescription: 'Rounds a number to a certain number of decimal places.', - parameters: [{name: 'Number', description: ''}, {name: 'Count', description: ''}], + parameters: [{name: 'number', description: ''}, {name: 'count', description: ''}], }, ROUNDDOWN: { category: 'Math and trigonometry', shortDescription: 'Rounds a number down, toward zero, to a certain precision.', - parameters: [{name: 'Number', description: ''}, {name: 'Count', description: ''}], + parameters: [{name: 'number', description: ''}, {name: 'count', description: ''}], }, ROUNDUP: { category: 'Math and trigonometry', shortDescription: 'Rounds a number up, away from zero, to a certain precision.', - parameters: [{name: 'Number', description: ''}, {name: 'Count', description: ''}], + parameters: [{name: 'number', description: ''}, {name: 'count', description: ''}], }, SEC: { category: 'Math and trigonometry', shortDescription: 'Returns the secant of the given angle (in radians).', - parameters: [{name: 'Number', description: ''}], + parameters: [{name: 'number', description: ''}], }, SECH: { category: 'Math and trigonometry', shortDescription: 'Returns the hyperbolic secant of the given angle (in radians).', - parameters: [{name: 'Number', description: ''}], + parameters: [{name: 'number', description: ''}], }, SERIESSUM: { category: 'Math and trigonometry', shortDescription: 'Evaluates series at a point.', - parameters: [{name: 'Number1', description: ''}, {name: 'Number2', description: ''}, {name: 'Number3', description: ''}, {name: 'Coefficients', description: ''}], + parameters: [{name: 'number1', description: ''}, {name: 'number2', description: ''}, {name: 'number3', description: ''}, {name: 'coefficients', description: ''}], }, SIGN: { category: 'Math and trigonometry', shortDescription: 'Returns sign of a number.', - parameters: [{name: 'Number', description: ''}], + parameters: [{name: 'number', description: ''}], }, SIN: { category: 'Math and trigonometry', shortDescription: 'Returns the sine of the given angle (in radians).', - parameters: [{name: 'Number', description: ''}], + parameters: [{name: 'number', description: ''}], }, SINH: { category: 'Math and trigonometry', shortDescription: 'Returns the hyperbolic sine of the given value.', - parameters: [{name: 'Number', description: ''}], + parameters: [{name: 'number', description: ''}], }, SQRT: { category: 'Math and trigonometry', shortDescription: 'Returns the positive square root of a number.', - parameters: [{name: 'Number', description: ''}], + parameters: [{name: 'number', description: ''}], }, SQRTPI: { category: 'Math and trigonometry', shortDescription: 'Returns sqrt of number times pi.', - parameters: [{name: 'Number', description: ''}], + parameters: [{name: 'number', description: ''}], }, SUBTOTAL: { category: 'Math and trigonometry', shortDescription: 'Computes aggregation using function specified by number.', - parameters: [{name: 'Function', description: ''}, {name: 'Number1', description: ''}], + parameters: [{name: 'function', description: ''}, {name: 'number1', description: ''}], }, // HAND-AUTHORED reference functions (HF-249): SUM and SUMIF carry real parameter descriptions, examples and a // documentationUrl so the Formula Builder team can test rendering of populated metadata. The migration generator @@ -332,7 +332,7 @@ export const MATH_AND_TRIGONOMETRY_DOCS: Record = { SUM: { category: 'Math and trigonometry', shortDescription: 'Sums up the values of the specified cells.', - parameters: [{name: 'Number1', description: 'A number, cell reference, or range whose values are added together. Further numbers or ranges can be passed as additional arguments.'}], + parameters: [{name: 'number1', description: 'A number, cell reference, or range whose values are added together. Further numbers or ranges can be passed as additional arguments.'}], documentationUrl: 'https://hyperformula.handsontable.com/docs/guide/built-in-functions', examples: ['=SUM(1, 2, 3)', '=SUM(A1:A10)', '=SUM(B1:B5, 100)'], }, @@ -340,9 +340,9 @@ export const MATH_AND_TRIGONOMETRY_DOCS: Record = { category: 'Math and trigonometry', shortDescription: 'Sums up the values of cells that belong to the specified range and meet the specified condition.', parameters: [ - {name: 'Range', description: 'The range of cells tested against the criterion.'}, - {name: 'Criteria', description: 'The condition that selects which cells are summed, e.g. ">5", "apples", or a cell reference.'}, - {name: 'Sumrange', description: 'The range of cells to sum. When omitted, the cells in Range are summed instead.'}, + {name: 'range', description: 'The range of cells tested against the criterion.'}, + {name: 'criteria', description: 'The condition that selects which cells are summed, e.g. ">5", "apples", or a cell reference.'}, + {name: 'sum_range', description: 'The range of cells to sum. When omitted, the cells in Range are summed instead.'}, ], documentationUrl: 'https://hyperformula.handsontable.com/docs/guide/built-in-functions', examples: ['=SUMIF(A1:A10, ">5")', '=SUMIF(B1:B10, "apples", C1:C10)'], @@ -350,41 +350,41 @@ export const MATH_AND_TRIGONOMETRY_DOCS: Record = { SUMIFS: { category: 'Math and trigonometry', shortDescription: 'Sums up the values of cells that belong to the specified range and meet the specified sets of conditions.', - parameters: [{name: 'Sum_Range', description: ''}, {name: 'Criterion_range1', description: ''}, {name: 'Criterion1', description: ''}], + parameters: [{name: 'sum_range', description: ''}, {name: 'criterion_range1', description: ''}, {name: 'criterion1', description: ''}], }, SUMPRODUCT: { category: 'Math and trigonometry', shortDescription: 'Multiplies corresponding elements in the given arrays, and returns the sum of those products.', - parameters: [{name: 'Array1', description: ''}], + parameters: [{name: 'array1', description: ''}], }, SUMSQ: { category: 'Math and trigonometry', shortDescription: 'Returns the sum of the squares of the arguments', - parameters: [{name: 'Number1', description: ''}], + parameters: [{name: 'number1', description: ''}], }, SUMX2MY2: { category: 'Math and trigonometry', shortDescription: 'Returns the sum of the square differences.', - parameters: [{name: 'Range1', description: ''}, {name: 'Range2', description: ''}], + parameters: [{name: 'range1', description: ''}, {name: 'range2', description: ''}], }, SUMX2PY2: { category: 'Math and trigonometry', shortDescription: 'Returns the sum of the square sums.', - parameters: [{name: 'Range1', description: ''}, {name: 'Range2', description: ''}], + parameters: [{name: 'range1', description: ''}, {name: 'range2', description: ''}], }, SUMXMY2: { category: 'Math and trigonometry', shortDescription: 'Returns the sum of the square of differences.', - parameters: [{name: 'Range1', description: ''}, {name: 'Range2', description: ''}], + parameters: [{name: 'range1', description: ''}, {name: 'range2', description: ''}], }, TAN: { category: 'Math and trigonometry', shortDescription: 'Returns the tangent of the given angle (in radians).', - parameters: [{name: 'Number', description: ''}], + parameters: [{name: 'number', description: ''}], }, TANH: { category: 'Math and trigonometry', shortDescription: 'Returns the hyperbolic tangent of the given value.', - parameters: [{name: 'Number', description: ''}], + parameters: [{name: 'number', description: ''}], }, } diff --git a/src/interpreter/functionMetadata/categories/matrix-functions.ts b/src/interpreter/functionMetadata/categories/matrix-functions.ts index 7efebad71..fc3f4ded3 100644 --- a/src/interpreter/functionMetadata/categories/matrix-functions.ts +++ b/src/interpreter/functionMetadata/categories/matrix-functions.ts @@ -13,21 +13,21 @@ export const MATRIX_FUNCTIONS_DOCS: Record = { MAXPOOL: { category: 'Matrix functions', shortDescription: 'Calculates a smaller range which is a maximum of a Window_size, in a given Range, for every Stride element.', - parameters: [{name: 'Range', description: ''}, {name: 'Window_size', description: ''}, {name: 'Stride', description: ''}], + parameters: [{name: 'range', description: ''}, {name: 'window_size', description: ''}, {name: 'stride', description: ''}], }, MEDIANPOOL: { category: 'Matrix functions', shortDescription: 'Calculates a smaller range which is a median of a Window_size, in a given Range, for every Stride element.', - parameters: [{name: 'Range', description: ''}, {name: 'Window_size', description: ''}, {name: 'Stride', description: ''}], + parameters: [{name: 'range', description: ''}, {name: 'window_size', description: ''}, {name: 'stride', description: ''}], }, MMULT: { category: 'Matrix functions', shortDescription: 'Calculates the array product of two arrays.', - parameters: [{name: 'Array1', description: ''}, {name: 'Array2', description: ''}], + parameters: [{name: 'array1', description: ''}, {name: 'array2', description: ''}], }, TRANSPOSE: { category: 'Matrix functions', shortDescription: 'Transposes the rows and columns of an array.', - parameters: [{name: 'Array', description: ''}], + parameters: [{name: 'array', description: ''}], }, } diff --git a/src/interpreter/functionMetadata/categories/operator.ts b/src/interpreter/functionMetadata/categories/operator.ts index 9305a5ebd..d7a7258b8 100644 --- a/src/interpreter/functionMetadata/categories/operator.ts +++ b/src/interpreter/functionMetadata/categories/operator.ts @@ -13,76 +13,76 @@ export const OPERATOR_DOCS: Record = { 'HF.ADD': { category: 'Operator', shortDescription: 'Adds two values.', - parameters: [{name: 'Number1', description: ''}, {name: 'Number2', description: ''}], + parameters: [{name: 'number1', description: ''}, {name: 'number2', description: ''}], }, 'HF.CONCAT': { category: 'Operator', shortDescription: 'Concatenates two strings.', - parameters: [{name: 'String1', description: ''}, {name: 'String2', description: ''}], + parameters: [{name: 'string1', description: ''}, {name: 'string2', description: ''}], }, 'HF.DIVIDE': { category: 'Operator', shortDescription: 'Divides two values.', - parameters: [{name: 'Number1', description: ''}, {name: 'Number2', description: ''}], + parameters: [{name: 'number1', description: ''}, {name: 'number2', description: ''}], }, 'HF.EQ': { category: 'Operator', shortDescription: 'Tests two values for equality.', - parameters: [{name: 'Value1', description: ''}, {name: 'Value2', description: ''}], + parameters: [{name: 'value1', description: ''}, {name: 'value2', description: ''}], }, 'HF.GT': { category: 'Operator', shortDescription: 'Tests two values for greater-than relation.', - parameters: [{name: 'Value1', description: ''}, {name: 'Value2', description: ''}], + parameters: [{name: 'value1', description: ''}, {name: 'value2', description: ''}], }, 'HF.GTE': { category: 'Operator', shortDescription: 'Tests two values for greater-equal relation.', - parameters: [{name: 'Value1', description: ''}, {name: 'Value2', description: ''}], + parameters: [{name: 'value1', description: ''}, {name: 'value2', description: ''}], }, 'HF.LT': { category: 'Operator', shortDescription: 'Tests two values for less-than relation.', - parameters: [{name: 'Value1', description: ''}, {name: 'Value2', description: ''}], + parameters: [{name: 'value1', description: ''}, {name: 'value2', description: ''}], }, 'HF.LTE': { category: 'Operator', shortDescription: 'Tests two values for less-equal relation.', - parameters: [{name: 'Value1', description: ''}, {name: 'Value2', description: ''}], + parameters: [{name: 'value1', description: ''}, {name: 'value2', description: ''}], }, 'HF.MINUS': { category: 'Operator', shortDescription: 'Subtracts two values.', - parameters: [{name: 'Number1', description: ''}, {name: 'Number2', description: ''}], + parameters: [{name: 'number1', description: ''}, {name: 'number2', description: ''}], }, 'HF.MULTIPLY': { category: 'Operator', shortDescription: 'Multiplies two values.', - parameters: [{name: 'Number1', description: ''}, {name: 'Number2', description: ''}], + parameters: [{name: 'number1', description: ''}, {name: 'number2', description: ''}], }, 'HF.NE': { category: 'Operator', shortDescription: 'Tests two values for inequality.', - parameters: [{name: 'Value1', description: ''}, {name: 'Value2', description: ''}], + parameters: [{name: 'value1', description: ''}, {name: 'value2', description: ''}], }, 'HF.POW': { category: 'Operator', shortDescription: 'Computes power of two values.', - parameters: [{name: 'Number1', description: ''}, {name: 'Number2', description: ''}], + parameters: [{name: 'number1', description: ''}, {name: 'number2', description: ''}], }, 'HF.UMINUS': { category: 'Operator', shortDescription: 'Negates the value.', - parameters: [{name: 'Number', description: ''}], + parameters: [{name: 'number', description: ''}], }, 'HF.UNARY_PERCENT': { category: 'Operator', shortDescription: 'Applies percent operator.', - parameters: [{name: 'Number', description: ''}], + parameters: [{name: 'number', description: ''}], }, 'HF.UPLUS': { category: 'Operator', shortDescription: 'Applies unary plus.', - parameters: [{name: 'Number', description: ''}], + parameters: [{name: 'number', description: ''}], }, } diff --git a/src/interpreter/functionMetadata/categories/statistical.ts b/src/interpreter/functionMetadata/categories/statistical.ts index 2e88fa8e3..9e9ce0f53 100644 --- a/src/interpreter/functionMetadata/categories/statistical.ts +++ b/src/interpreter/functionMetadata/categories/statistical.ts @@ -13,446 +13,446 @@ export const STATISTICAL_DOCS: Record = { AVEDEV: { category: 'Statistical', shortDescription: 'Returns the average deviation of the arguments.', - parameters: [{name: 'Number1', description: ''}], + parameters: [{name: 'number1', description: ''}], }, AVERAGE: { category: 'Statistical', shortDescription: 'Returns the average of the arguments.', - parameters: [{name: 'Number1', description: ''}], + parameters: [{name: 'number1', description: ''}], }, AVERAGEA: { category: 'Statistical', shortDescription: 'Returns the average of the arguments.', - parameters: [{name: 'Value1', description: ''}], + parameters: [{name: 'value1', description: ''}], }, AVERAGEIF: { category: 'Statistical', shortDescription: 'Returns the arithmetic mean of all cells in a range that satisfy a given condition.', - parameters: [{name: 'Range', description: ''}, {name: 'Criterion', description: ''}, {name: 'Average_Range', description: ''}], + parameters: [{name: 'range', description: ''}, {name: 'criterion', description: ''}, {name: 'average_range', description: ''}], }, BESSELI: { category: 'Statistical', shortDescription: 'Returns value of Bessel function.', - parameters: [{name: 'X', description: ''}, {name: 'N', description: ''}], + parameters: [{name: 'x', description: ''}, {name: 'n', description: ''}], }, BESSELJ: { category: 'Statistical', shortDescription: 'Returns value of Bessel function.', - parameters: [{name: 'X', description: ''}, {name: 'N', description: ''}], + parameters: [{name: 'x', description: ''}, {name: 'n', description: ''}], }, BESSELK: { category: 'Statistical', shortDescription: 'Returns value of Bessel function.', - parameters: [{name: 'X', description: ''}, {name: 'N', description: ''}], + parameters: [{name: 'x', description: ''}, {name: 'n', description: ''}], }, BESSELY: { category: 'Statistical', shortDescription: 'Returns value of Bessel function.', - parameters: [{name: 'X', description: ''}, {name: 'N', description: ''}], + parameters: [{name: 'x', description: ''}, {name: 'n', description: ''}], }, 'BETA.DIST': { category: 'Statistical', shortDescription: 'Returns the density of Beta distribution.', - parameters: [{name: 'Number1', description: ''}, {name: 'Number2', description: ''}, {name: 'Number3', description: ''}, {name: 'Boolean', description: ''}, {name: 'Number4', description: ''}, {name: 'Number5', description: ''}], + parameters: [{name: 'number1', description: ''}, {name: 'number2', description: ''}, {name: 'number3', description: ''}, {name: 'boolean', description: ''}, {name: 'number4', description: ''}, {name: 'number5', description: ''}], }, 'BETA.INV': { category: 'Statistical', shortDescription: 'Returns the inverse Beta distribution value.', - parameters: [{name: 'Number1', description: ''}, {name: 'Number2', description: ''}, {name: 'Number3', description: ''}, {name: 'Number4', description: ''}, {name: 'Number5', description: ''}], + parameters: [{name: 'number1', description: ''}, {name: 'number2', description: ''}, {name: 'number3', description: ''}, {name: 'number4', description: ''}, {name: 'number5', description: ''}], }, 'BINOM.DIST': { category: 'Statistical', shortDescription: 'Returns density of binomial distribution.', - parameters: [{name: 'Number1', description: ''}, {name: 'Number2', description: ''}, {name: 'Number3', description: ''}, {name: 'Boolean', description: ''}], + parameters: [{name: 'number1', description: ''}, {name: 'number2', description: ''}, {name: 'number3', description: ''}, {name: 'boolean', description: ''}], }, 'BINOM.INV': { category: 'Statistical', shortDescription: 'Returns inverse binomial distribution value.', - parameters: [{name: 'Number1', description: ''}, {name: 'Number2', description: ''}, {name: 'Number3', description: ''}], + parameters: [{name: 'number1', description: ''}, {name: 'number2', description: ''}, {name: 'number3', description: ''}], }, 'CHISQ.DIST': { category: 'Statistical', shortDescription: 'Returns value of chi-square distribution.', - parameters: [{name: 'X', description: ''}, {name: 'Degrees', description: ''}, {name: 'Mode', description: ''}], + parameters: [{name: 'x', description: ''}, {name: 'degrees', description: ''}, {name: 'mode', description: ''}], }, 'CHISQ.DIST.RT': { category: 'Statistical', shortDescription: 'Returns probability of chi-square right-side distribution.', - parameters: [{name: 'X', description: ''}, {name: 'Degrees', description: ''}], + parameters: [{name: 'x', description: ''}, {name: 'degrees', description: ''}], }, 'CHISQ.INV': { category: 'Statistical', shortDescription: 'Returns inverse of chi-square distribution.', - parameters: [{name: 'P', description: ''}, {name: 'Degrees', description: ''}], + parameters: [{name: 'p', description: ''}, {name: 'degrees', description: ''}], }, 'CHISQ.INV.RT': { category: 'Statistical', shortDescription: 'Returns inverse of chi-square right-side distribution.', - parameters: [{name: 'P', description: ''}, {name: 'Degrees', description: ''}], + parameters: [{name: 'p', description: ''}, {name: 'degrees', description: ''}], }, 'CHISQ.TEST': { category: 'Statistical', shortDescription: 'Returns chisquared-test value for a dataset.', - parameters: [{name: 'Array1', description: ''}, {name: 'Array2', description: ''}], + parameters: [{name: 'array1', description: ''}, {name: 'array2', description: ''}], }, 'CONFIDENCE.NORM': { category: 'Statistical', shortDescription: 'Returns upper confidence bound for normal distribution.', - parameters: [{name: 'Alpha', description: ''}, {name: 'Stdev', description: ''}, {name: 'Size', description: ''}], + parameters: [{name: 'alpha', description: ''}, {name: 'stdev', description: ''}, {name: 'size', description: ''}], }, 'CONFIDENCE.T': { category: 'Statistical', shortDescription: 'Returns upper confidence bound for T distribution.', - parameters: [{name: 'Alpha', description: ''}, {name: 'Stdev', description: ''}, {name: 'Size', description: ''}], + parameters: [{name: 'alpha', description: ''}, {name: 'stdev', description: ''}, {name: 'size', description: ''}], }, CORREL: { category: 'Statistical', shortDescription: 'Returns the correlation coefficient between two data sets.', - parameters: [{name: 'Data1', description: ''}, {name: 'Data2', description: ''}], + parameters: [{name: 'data1', description: ''}, {name: 'data2', description: ''}], }, COUNT: { category: 'Statistical', shortDescription: 'Counts how many numbers are in the list of arguments.', - parameters: [{name: 'Value1', description: ''}], + parameters: [{name: 'value1', description: ''}], }, COUNTA: { category: 'Statistical', shortDescription: 'Counts how many values are in the list of arguments.', - parameters: [{name: 'Value1', description: ''}], + parameters: [{name: 'value1', description: ''}], }, COUNTBLANK: { category: 'Statistical', shortDescription: 'Returns the number of empty cells.', - parameters: [{name: 'Range', description: ''}], + parameters: [{name: 'range', description: ''}], }, COUNTIF: { category: 'Statistical', shortDescription: 'Returns the number of cells that meet with certain criteria within a cell range.', - parameters: [{name: 'Range', description: ''}, {name: 'Criteria', description: ''}], + parameters: [{name: 'range', description: ''}, {name: 'criteria', description: ''}], }, COUNTIFS: { category: 'Statistical', shortDescription: 'Returns the count of rows or columns that meet criteria in multiple ranges.', - parameters: [{name: 'Range1', description: ''}, {name: 'Criterion1', description: ''}], + parameters: [{name: 'range1', description: ''}, {name: 'criterion1', description: ''}], }, 'COVARIANCE.P': { category: 'Statistical', shortDescription: 'Returns the covariance between two data sets, population normalized.', - parameters: [{name: 'Data1', description: ''}, {name: 'Data2', description: ''}], + parameters: [{name: 'data1', description: ''}, {name: 'data2', description: ''}], }, 'COVARIANCE.S': { category: 'Statistical', shortDescription: 'Returns the covariance between two data sets, sample normalized.', - parameters: [{name: 'Data1', description: ''}, {name: 'Data2', description: ''}], + parameters: [{name: 'data1', description: ''}, {name: 'data2', description: ''}], }, DEVSQ: { category: 'Statistical', shortDescription: 'Returns sum of squared deviations.', - parameters: [{name: 'Number1', description: ''}], + parameters: [{name: 'number1', description: ''}], }, 'EXPON.DIST': { category: 'Statistical', shortDescription: 'Returns density of a exponential distribution.', - parameters: [{name: 'Number1', description: ''}, {name: 'Number2', description: ''}, {name: 'Boolean', description: ''}], + parameters: [{name: 'number1', description: ''}, {name: 'number2', description: ''}, {name: 'boolean', description: ''}], }, 'F.DIST': { category: 'Statistical', shortDescription: 'Returns value of F distribution.', - parameters: [{name: 'X', description: ''}, {name: 'Degree1', description: ''}, {name: 'Degree2', description: ''}, {name: 'Mode', description: ''}], + parameters: [{name: 'x', description: ''}, {name: 'degree1', description: ''}, {name: 'degree2', description: ''}, {name: 'mode', description: ''}], }, 'F.DIST.RT': { category: 'Statistical', shortDescription: 'Returns probability of F right-side distribution.', - parameters: [{name: 'X', description: ''}, {name: 'Degree1', description: ''}, {name: 'Degree2', description: ''}], + parameters: [{name: 'x', description: ''}, {name: 'degree1', description: ''}, {name: 'degree2', description: ''}], }, 'F.INV': { category: 'Statistical', shortDescription: 'Returns inverse of F distribution.', - parameters: [{name: 'P', description: ''}, {name: 'Degree1', description: ''}, {name: 'Degree2', description: ''}], + parameters: [{name: 'p', description: ''}, {name: 'degree1', description: ''}, {name: 'degree2', description: ''}], }, 'F.INV.RT': { category: 'Statistical', shortDescription: 'Returns inverse of F right-side distribution.', - parameters: [{name: 'P', description: ''}, {name: 'Degree1', description: ''}, {name: 'Degree2', description: ''}], + parameters: [{name: 'p', description: ''}, {name: 'degree1', description: ''}, {name: 'degree2', description: ''}], }, 'F.TEST': { category: 'Statistical', shortDescription: 'Returns f-test value for a dataset.', - parameters: [{name: 'Array1', description: ''}, {name: 'Array2', description: ''}], + parameters: [{name: 'array1', description: ''}, {name: 'array2', description: ''}], }, FISHER: { category: 'Statistical', shortDescription: 'Returns Fisher transformation value.', - parameters: [{name: 'Number', description: ''}], + parameters: [{name: 'number', description: ''}], }, FISHERINV: { category: 'Statistical', shortDescription: 'Returns inverse Fischer transformation value.', - parameters: [{name: 'Number', description: ''}], + parameters: [{name: 'number', description: ''}], }, GAMMA: { category: 'Statistical', shortDescription: 'Returns value of Gamma function.', - parameters: [{name: 'Number', description: ''}], + parameters: [{name: 'number', description: ''}], }, 'GAMMA.DIST': { category: 'Statistical', shortDescription: 'Returns density of Gamma distribution.', - parameters: [{name: 'Number1', description: ''}, {name: 'Number2', description: ''}, {name: 'Number3', description: ''}, {name: 'Boolean', description: ''}], + parameters: [{name: 'number1', description: ''}, {name: 'number2', description: ''}, {name: 'number3', description: ''}, {name: 'boolean', description: ''}], }, 'GAMMA.INV': { category: 'Statistical', shortDescription: 'Returns inverse Gamma distribution value.', - parameters: [{name: 'Number1', description: ''}, {name: 'Number2', description: ''}, {name: 'Number3', description: ''}], + parameters: [{name: 'number1', description: ''}, {name: 'number2', description: ''}, {name: 'number3', description: ''}], }, GAMMALN: { category: 'Statistical', shortDescription: 'Returns natural logarithm of Gamma function.', - parameters: [{name: 'Number', description: ''}], + parameters: [{name: 'number', description: ''}], }, GAUSS: { category: 'Statistical', shortDescription: 'Returns the probability of gaussian variable falling more than this many times standard deviation from mean.', - parameters: [{name: 'Number', description: ''}], + parameters: [{name: 'number', description: ''}], }, GEOMEAN: { category: 'Statistical', shortDescription: 'Returns the geometric average.', - parameters: [{name: 'Number1', description: ''}], + parameters: [{name: 'number1', description: ''}], }, HARMEAN: { category: 'Statistical', shortDescription: 'Returns the harmonic average.', - parameters: [{name: 'Number1', description: ''}], + parameters: [{name: 'number1', description: ''}], }, 'HYPGEOM.DIST': { category: 'Statistical', shortDescription: 'Returns density of hypergeometric distribution.', - parameters: [{name: 'Number1', description: ''}, {name: 'Number2', description: ''}, {name: 'Number3', description: ''}, {name: 'Number4', description: ''}, {name: 'Boolean', description: ''}], + parameters: [{name: 'number1', description: ''}, {name: 'number2', description: ''}, {name: 'number3', description: ''}, {name: 'number4', description: ''}, {name: 'boolean', description: ''}], }, LARGE: { category: 'Statistical', shortDescription: 'Returns k-th largest value in a range.', - parameters: [{name: 'Range', description: ''}, {name: 'K', description: ''}], + parameters: [{name: 'range', description: ''}, {name: 'k', description: ''}], }, 'LOGNORM.DIST': { category: 'Statistical', shortDescription: 'Returns density of lognormal distribution.', - parameters: [{name: 'X', description: ''}, {name: 'Mean', description: ''}, {name: 'Stddev', description: ''}, {name: 'Mode', description: ''}], + parameters: [{name: 'x', description: ''}, {name: 'mean', description: ''}, {name: 'stddev', description: ''}, {name: 'mode', description: ''}], }, 'LOGNORM.INV': { category: 'Statistical', shortDescription: 'Returns value of inverse lognormal distribution.', - parameters: [{name: 'P', description: ''}, {name: 'Mean', description: ''}, {name: 'Stddev', description: ''}], + parameters: [{name: 'p', description: ''}, {name: 'mean', description: ''}, {name: 'stddev', description: ''}], }, MAX: { category: 'Statistical', shortDescription: 'Returns the maximum value in a list of arguments.', - parameters: [{name: 'Number1', description: ''}], + parameters: [{name: 'number1', description: ''}], }, MAXA: { category: 'Statistical', shortDescription: 'Returns the maximum value in a list of arguments.', - parameters: [{name: 'Value1', description: ''}], + parameters: [{name: 'value1', description: ''}], }, MAXIFS: { category: 'Statistical', shortDescription: 'Returns the maximum value of the cells in a range that meet a set of criteria.', - parameters: [{name: 'Max_Range', description: ''}, {name: 'Criterion_range1', description: ''}, {name: 'Criterion1', description: ''}], + parameters: [{name: 'max_range', description: ''}, {name: 'criterion_range1', description: ''}, {name: 'criterion1', description: ''}], }, MEDIAN: { category: 'Statistical', shortDescription: 'Returns the median of a set of numbers.', - parameters: [{name: 'Number1', description: ''}], + parameters: [{name: 'number1', description: ''}], }, MIN: { category: 'Statistical', shortDescription: 'Returns the minimum value in a list of arguments.', - parameters: [{name: 'Number1', description: ''}], + parameters: [{name: 'number1', description: ''}], }, MINA: { category: 'Statistical', shortDescription: 'Returns the minimum value in a list of arguments.', - parameters: [{name: 'Value1', description: ''}], + parameters: [{name: 'value1', description: ''}], }, MINIFS: { category: 'Statistical', shortDescription: 'Returns the minimum value of the cells in a range that meet a set of criteria.', - parameters: [{name: 'Min_Range', description: ''}, {name: 'Criterion_range1', description: ''}, {name: 'Criterion1', description: ''}], + parameters: [{name: 'min_range', description: ''}, {name: 'criterion_range1', description: ''}, {name: 'criterion1', description: ''}], }, 'NEGBINOM.DIST': { category: 'Statistical', shortDescription: 'Returns density of negative binomial distribution.', - parameters: [{name: 'Number1', description: ''}, {name: 'Number2', description: ''}, {name: 'Number3', description: ''}, {name: 'Mode', description: ''}], + parameters: [{name: 'number1', description: ''}, {name: 'number2', description: ''}, {name: 'number3', description: ''}, {name: 'mode', description: ''}], }, 'NORM.DIST': { category: 'Statistical', shortDescription: 'Returns density of normal distribution.', - parameters: [{name: 'X', description: ''}, {name: 'Mean', description: ''}, {name: 'Stddev', description: ''}, {name: 'Mode', description: ''}], + parameters: [{name: 'x', description: ''}, {name: 'mean', description: ''}, {name: 'stddev', description: ''}, {name: 'mode', description: ''}], }, 'NORM.INV': { category: 'Statistical', shortDescription: 'Returns value of inverse normal distribution.', - parameters: [{name: 'P', description: ''}, {name: 'Mean', description: ''}, {name: 'Stddev', description: ''}], + parameters: [{name: 'p', description: ''}, {name: 'mean', description: ''}, {name: 'stddev', description: ''}], }, 'NORM.S.DIST': { category: 'Statistical', shortDescription: 'Returns density of normal distribution.', - parameters: [{name: 'X', description: ''}, {name: 'Mode', description: ''}], + parameters: [{name: 'x', description: ''}, {name: 'mode', description: ''}], }, 'NORM.S.INV': { category: 'Statistical', shortDescription: 'Returns value of inverse normal distribution.', - parameters: [{name: 'P', description: ''}], + parameters: [{name: 'p', description: ''}], }, 'PERCENTILE.EXC': { category: 'Statistical', shortDescription: 'Returns the k-th percentile of values in a range, exclusive of 0 and 1.', - parameters: [{name: 'Data', description: ''}, {name: 'K', description: ''}], + parameters: [{name: 'data', description: ''}, {name: 'k', description: ''}], }, 'PERCENTILE.INC': { category: 'Statistical', shortDescription: 'Returns the k-th percentile of values in a range, inclusive of 0 and 1.', - parameters: [{name: 'Data', description: ''}, {name: 'K', description: ''}], + parameters: [{name: 'data', description: ''}, {name: 'k', description: ''}], }, PHI: { category: 'Statistical', shortDescription: 'Returns probability densitity of normal distribution.', - parameters: [{name: 'X', description: ''}], + parameters: [{name: 'x', description: ''}], }, 'POISSON.DIST': { category: 'Statistical', shortDescription: 'Returns density of Poisson distribution.', - parameters: [{name: 'X', description: ''}, {name: 'Mean', description: ''}, {name: 'Mode', description: ''}], + parameters: [{name: 'x', description: ''}, {name: 'mean', description: ''}, {name: 'mode', description: ''}], }, 'QUARTILE.EXC': { category: 'Statistical', shortDescription: 'Returns the quartile of a data set, based on exclusive percentile values.', - parameters: [{name: 'Data', description: ''}, {name: 'Quart', description: ''}], + parameters: [{name: 'data', description: ''}, {name: 'quart', description: ''}], }, 'QUARTILE.INC': { category: 'Statistical', shortDescription: 'Returns the quartile of a data set, based on inclusive percentile values.', - parameters: [{name: 'Data', description: ''}, {name: 'Quart', description: ''}], + parameters: [{name: 'data', description: ''}, {name: 'quart', description: ''}], }, RSQ: { category: 'Statistical', shortDescription: 'Returns the squared correlation coefficient between two data sets.', - parameters: [{name: 'Data1', description: ''}, {name: 'Data2', description: ''}], + parameters: [{name: 'data1', description: ''}, {name: 'data2', description: ''}], }, SKEW: { category: 'Statistical', shortDescription: 'Returns skeweness of a sample.', - parameters: [{name: 'Number1', description: ''}], + parameters: [{name: 'number1', description: ''}], }, 'SKEW.P': { category: 'Statistical', shortDescription: 'Returns skeweness of a population.', - parameters: [{name: 'Number1', description: ''}], + parameters: [{name: 'number1', description: ''}], }, SLOPE: { category: 'Statistical', shortDescription: 'Returns the slope of a linear regression line.', - parameters: [{name: 'Array1', description: ''}, {name: 'Array2', description: ''}], + parameters: [{name: 'array1', description: ''}, {name: 'array2', description: ''}], }, SMALL: { category: 'Statistical', shortDescription: 'Returns k-th smallest value in a range.', - parameters: [{name: 'Range', description: ''}, {name: 'K', description: ''}], + parameters: [{name: 'range', description: ''}, {name: 'k', description: ''}], }, STANDARDIZE: { category: 'Statistical', shortDescription: 'Returns normalized value wrt expected value and standard deviation.', - parameters: [{name: 'X', description: ''}, {name: 'Mean', description: ''}, {name: 'Stddev', description: ''}], + parameters: [{name: 'x', description: ''}, {name: 'mean', description: ''}, {name: 'stddev', description: ''}], }, 'STDEV.P': { category: 'Statistical', shortDescription: 'Returns standard deviation of a population.', - parameters: [{name: 'Value1', description: ''}], + parameters: [{name: 'value1', description: ''}], }, 'STDEV.S': { category: 'Statistical', shortDescription: 'Returns standard deviation of a sample.', - parameters: [{name: 'Value1', description: ''}], + parameters: [{name: 'value1', description: ''}], }, STDEVA: { category: 'Statistical', shortDescription: 'Returns standard deviation of a sample.', - parameters: [{name: 'Value1', description: ''}], + parameters: [{name: 'value1', description: ''}], }, STDEVPA: { category: 'Statistical', shortDescription: 'Returns standard deviation of a population.', - parameters: [{name: 'Value1', description: ''}], + parameters: [{name: 'value1', description: ''}], }, STEYX: { category: 'Statistical', shortDescription: 'Returns standard error for predicted of the predicted y value for each x value.', - parameters: [{name: 'Array1', description: ''}, {name: 'Array2', description: ''}], + parameters: [{name: 'array1', description: ''}, {name: 'array2', description: ''}], }, 'T.DIST': { category: 'Statistical', shortDescription: 'Returns density of Student-t distribution.', - parameters: [{name: 'X', description: ''}, {name: 'Degrees', description: ''}, {name: 'Mode', description: ''}], + parameters: [{name: 'x', description: ''}, {name: 'degrees', description: ''}, {name: 'mode', description: ''}], }, 'T.DIST.2T': { category: 'Statistical', shortDescription: 'Returns density of Student-t distribution, both-sided.', - parameters: [{name: 'X', description: ''}, {name: 'Degrees', description: ''}], + parameters: [{name: 'x', description: ''}, {name: 'degrees', description: ''}], }, 'T.DIST.RT': { category: 'Statistical', shortDescription: 'Returns density of Student-t distribution, right-tailed.', - parameters: [{name: 'X', description: ''}, {name: 'Degrees', description: ''}], + parameters: [{name: 'x', description: ''}, {name: 'degrees', description: ''}], }, 'T.INV': { category: 'Statistical', shortDescription: 'Returns inverse Student-t distribution.', - parameters: [{name: 'P', description: ''}, {name: 'Degrees', description: ''}], + parameters: [{name: 'p', description: ''}, {name: 'degrees', description: ''}], }, 'T.INV.2T': { category: 'Statistical', shortDescription: 'Returns inverse Student-t distribution, both-sided.', - parameters: [{name: 'P', description: ''}, {name: 'Degrees', description: ''}], + parameters: [{name: 'p', description: ''}, {name: 'degrees', description: ''}], }, 'T.TEST': { category: 'Statistical', shortDescription: 'Returns t-test value for a dataset.', - parameters: [{name: 'Array1', description: ''}, {name: 'Array2', description: ''}, {name: 'Tails', description: ''}, {name: 'Type', description: ''}], + parameters: [{name: 'array1', description: ''}, {name: 'array2', description: ''}, {name: 'tails', description: ''}, {name: 'type', description: ''}], }, TDIST: { category: 'Statistical', shortDescription: 'Returns density of Student-t distribution, both-sided or right-tailed.', - parameters: [{name: 'X', description: ''}, {name: 'Degrees', description: ''}, {name: 'Mode', description: ''}], + parameters: [{name: 'x', description: ''}, {name: 'degrees', description: ''}, {name: 'mode', description: ''}], }, 'VAR.P': { category: 'Statistical', shortDescription: 'Returns variance of a population.', - parameters: [{name: 'Value1', description: ''}], + parameters: [{name: 'value1', description: ''}], }, 'VAR.S': { category: 'Statistical', shortDescription: 'Returns variance of a sample.', - parameters: [{name: 'Value1', description: ''}], + parameters: [{name: 'value1', description: ''}], }, VARA: { category: 'Statistical', shortDescription: 'Returns variance of a sample.', - parameters: [{name: 'Value1', description: ''}], + parameters: [{name: 'value1', description: ''}], }, VARPA: { category: 'Statistical', shortDescription: 'Returns variance of a population.', - parameters: [{name: 'Value1', description: ''}], + parameters: [{name: 'value1', description: ''}], }, 'WEIBULL.DIST': { category: 'Statistical', shortDescription: 'Returns density of Weibull distribution.', - parameters: [{name: 'Number1', description: ''}, {name: 'Number2', description: ''}, {name: 'Number3', description: ''}, {name: 'Boolean', description: ''}], + parameters: [{name: 'number1', description: ''}, {name: 'number2', description: ''}, {name: 'number3', description: ''}, {name: 'boolean', description: ''}], }, 'Z.TEST': { category: 'Statistical', shortDescription: 'Returns z-test value for a dataset.', - parameters: [{name: 'Array', description: ''}, {name: 'X', description: ''}, {name: 'Sigma', description: ''}], + parameters: [{name: 'array', description: ''}, {name: 'x', description: ''}, {name: 'sigma', description: ''}], }, } diff --git a/src/interpreter/functionMetadata/categories/text.ts b/src/interpreter/functionMetadata/categories/text.ts index 5b19fe850..c669cb14e 100644 --- a/src/interpreter/functionMetadata/categories/text.ts +++ b/src/interpreter/functionMetadata/categories/text.ts @@ -13,131 +13,131 @@ export const TEXT_DOCS: Record = { CHAR: { category: 'Text', shortDescription: 'Converts a number into a character according to the current code table.', - parameters: [{name: 'Number', description: ''}], + parameters: [{name: 'number', description: ''}], }, CLEAN: { category: 'Text', shortDescription: 'Returns text that has been "cleaned" of line breaks and other non-printable characters.', - parameters: [{name: 'Text', description: ''}], + parameters: [{name: 'text', description: ''}], }, CODE: { category: 'Text', shortDescription: 'Returns a numeric code for the first character in a text string.', - parameters: [{name: 'Text', description: ''}], + parameters: [{name: 'text', description: ''}], }, CONCATENATE: { category: 'Text', shortDescription: 'Combines several text strings into one string.', - parameters: [{name: 'Text1', description: ''}], + parameters: [{name: 'text1', description: ''}], }, EXACT: { category: 'Text', shortDescription: 'Returns TRUE if both text strings are exactly the same.', - parameters: [{name: 'Text1', description: ''}, {name: 'Text2', description: ''}], + parameters: [{name: 'text1', description: ''}, {name: 'text2', description: ''}], }, FIND: { category: 'Text', shortDescription: 'Returns the location of one text string inside another.', - parameters: [{name: 'Text1', description: ''}, {name: 'Text2', description: ''}, {name: 'Number', description: ''}], + parameters: [{name: 'text1', description: ''}, {name: 'text2', description: ''}, {name: 'number', description: ''}], }, LEFT: { category: 'Text', shortDescription: 'Extracts a given number of characters from the left side of a text string.', - parameters: [{name: 'Text', description: ''}, {name: 'Number', description: ''}], + parameters: [{name: 'text', description: ''}, {name: 'number', description: ''}], }, LEN: { category: 'Text', shortDescription: 'Returns length of a given text.', - parameters: [{name: 'Text', description: ''}], + parameters: [{name: 'text', description: ''}], }, LOWER: { category: 'Text', shortDescription: 'Returns text converted to lowercase.', - parameters: [{name: 'Text', description: ''}], + parameters: [{name: 'text', description: ''}], }, MID: { category: 'Text', shortDescription: 'Returns substring of a given length starting from Start_position.', - parameters: [{name: 'Text', description: ''}, {name: 'Start_position', description: ''}, {name: 'Length', description: ''}], + parameters: [{name: 'text', description: ''}, {name: 'start_position', description: ''}, {name: 'length', description: ''}], }, N: { category: 'Text', shortDescription: 'Converts a value to a number.', - parameters: [{name: 'Value', description: ''}], + parameters: [{name: 'value', description: ''}], }, PROPER: { category: 'Text', shortDescription: 'Capitalizes words given text string.', - parameters: [{name: 'Text', description: ''}], + parameters: [{name: 'text', description: ''}], }, REPLACE: { category: 'Text', shortDescription: 'Replaces substring of a text of a given length that starts at given position.', - parameters: [{name: 'Text', description: ''}, {name: 'Start_position', description: ''}, {name: 'Length', description: ''}, {name: 'New_text', description: ''}], + parameters: [{name: 'text', description: ''}, {name: 'start_position', description: ''}, {name: 'length', description: ''}, {name: 'new_text', description: ''}], }, REPT: { category: 'Text', shortDescription: 'Repeats text a given number of times.', - parameters: [{name: 'Text', description: ''}, {name: 'Number', description: ''}], + parameters: [{name: 'text', description: ''}, {name: 'number', description: ''}], }, RIGHT: { category: 'Text', shortDescription: 'Extracts a given number of characters from the right side of a text string.', - parameters: [{name: 'Text', description: ''}, {name: 'Number', description: ''}], + parameters: [{name: 'text', description: ''}, {name: 'number', description: ''}], }, SEARCH: { category: 'Text', shortDescription: 'Returns the location of Search_string inside Text. Case-insensitive. Allows the use of wildcards.', - parameters: [{name: 'Search_string', description: ''}, {name: 'Text', description: ''}, {name: 'Start_position', description: ''}], + parameters: [{name: 'search_string', description: ''}, {name: 'text', description: ''}, {name: 'start_position', description: ''}], }, SPLIT: { category: 'Text', shortDescription: 'Divides the provided text using the space character as a separator and returns the substring at the zero-based position specified by the second argument.
`SPLIT("Lorem ipsum", 0) -> "Lorem"`
`SPLIT("Lorem ipsum", 1) -> "ipsum"`', - parameters: [{name: 'Text', description: ''}, {name: 'Index', description: ''}], + parameters: [{name: 'text', description: ''}, {name: 'index', description: ''}], }, SUBSTITUTE: { category: 'Text', shortDescription: 'Returns string where occurrences of Old_text are replaced by New_text. Replaces only specific occurrence if last parameter is provided.', - parameters: [{name: 'Text', description: ''}, {name: 'Old_text', description: ''}, {name: 'New_text', description: ''}, {name: 'Occurrence', description: ''}], + parameters: [{name: 'text', description: ''}, {name: 'old_text', description: ''}, {name: 'new_text', description: ''}, {name: 'occurrence', description: ''}], }, T: { category: 'Text', shortDescription: 'Returns text if given value is text, empty string otherwise.', - parameters: [{name: 'Value', description: ''}], + parameters: [{name: 'value', description: ''}], }, TEXT: { category: 'Text', shortDescription: 'Converts a number into text according to a given format.
By default, accepts the same formats that can be passed to the [`dateFormats`](../api/interfaces/configparams.md#dateformats) option, but can be further customized with the [`stringifyDateTime`](../api/interfaces/configparams.md#stringifydatetime) option.', - parameters: [{name: 'Number', description: ''}, {name: 'Format', description: ''}], + parameters: [{name: 'number', description: ''}, {name: 'format', description: ''}], }, TEXTJOIN: { category: 'Text', shortDescription: 'Joins text from multiple strings and/or ranges with a delimiter. Supports array/range delimiters that cycle through gaps. When ignore_empty is TRUE, empty strings are skipped. Returns #VALUE! if result exceeds 32,767 characters.', - parameters: [{name: 'Delimiter', description: ''}, {name: 'Ignore_empty', description: ''}, {name: 'Text1', description: ''}], + parameters: [{name: 'delimiter', description: ''}, {name: 'ignore_empty', description: ''}, {name: 'text1', description: ''}], }, TRIM: { category: 'Text', shortDescription: 'Strips extra spaces from text.', - parameters: [{name: 'Text', description: ''}], + parameters: [{name: 'text', description: ''}], }, UNICHAR: { category: 'Text', shortDescription: 'Returns the character created by using provided code point.', - parameters: [{name: 'Number', description: ''}], + parameters: [{name: 'number', description: ''}], }, UNICODE: { category: 'Text', shortDescription: 'Returns the Unicode code point of a first character of a text.', - parameters: [{name: 'Text', description: ''}], + parameters: [{name: 'text', description: ''}], }, UPPER: { category: 'Text', shortDescription: 'Returns text converted to uppercase.', - parameters: [{name: 'Text', description: ''}], + parameters: [{name: 'text', description: ''}], }, VALUE: { category: 'Text', shortDescription: 'Parses a number, date, time, datetime, currency, or percentage from a text string.', - parameters: [{name: 'Text', description: ''}], + parameters: [{name: 'text', description: ''}], }, }