Skip to content

Commit

Permalink
docs: improve function code docs
Browse files Browse the repository at this point in the history
Co-authored-by: Jan Suleiman <jansule@users.noreply.github.com>
  • Loading branch information
KaiVolland and jansule committed Feb 12, 2024
1 parent 29d8231 commit fd2049d
Showing 1 changed file with 8 additions and 8 deletions.
16 changes: 8 additions & 8 deletions src/Component/FunctionUI/functionConfigs.ts
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,7 @@ export const functionConfigs: FunctionConfig[] = [
{
name: 'div',
type: 'number',
description: 'Returns the division of argument[0] by argument[1]',
description: 'Returns the division of the first argument by the second argument',
args: [{
type: 'number',
placeholder: '… enter a number'
Expand Down Expand Up @@ -274,7 +274,7 @@ export const functionConfigs: FunctionConfig[] = [
{
name: 'sub',
type: 'number',
description: 'Returns the result of substracting argument[1] from argument[0]',
description: 'Returns the result of subtracting the second argument from the first argument',
args: [{
type: 'number',
placeholder: '… enter a number'
Expand Down Expand Up @@ -495,7 +495,7 @@ export const functionConfigs: FunctionConfig[] = [
name: 'any',
type: 'boolean',
// TODO: how to make infinite amount of inputs
description: 'Resolves to true if any of the passed arguments resolves to true.',
description: 'Resolves to true if any of the passed arguments resolve to true.',
args: [{
type: 'boolean',
placeholder: '… string to check'
Expand All @@ -519,7 +519,7 @@ export const functionConfigs: FunctionConfig[] = [
{
name: 'greaterThan',
type: 'boolean',
description: 'Resolves to true if argument[0] is greater than argument[1]',
description: 'Resolves to true if the first argument is greater than the second argument',
args: [{
type: 'number',
placeholder: '… first argument'
Expand All @@ -531,7 +531,7 @@ export const functionConfigs: FunctionConfig[] = [
{
name: 'greaterThanOrEqualTo',
type: 'boolean',
description: 'Resolves to true if argument[0] is greater than or equal to argument[1]',
description: 'Resolves to true if the first argument is greater than or equal to the second argument',
args: [{
type: 'number',
placeholder: '… first argument'
Expand Down Expand Up @@ -562,7 +562,7 @@ export const functionConfigs: FunctionConfig[] = [
{
name: 'lessThan',
type: 'boolean',
description: 'Resolves to true if argument[0] is less than argument[1]',
description: 'Resolves to true if the first argument is less than the second argument',
args: [{
type: 'number',
placeholder: '… first argument'
Expand All @@ -574,7 +574,7 @@ export const functionConfigs: FunctionConfig[] = [
{
name: 'lessThanOrEqualTo',
type: 'boolean',
description: 'Resolves to true if argument[0] is less than or equal to argument[1]',
description: 'Resolves to true if the first argument is less than or equal to the second argument',
args: [{
type: 'number',
placeholder: '… first argument'
Expand All @@ -586,7 +586,7 @@ export const functionConfigs: FunctionConfig[] = [
{
name: 'not',
type: 'boolean',
description: 'Inverts the boolean value of argument[0]',
description: 'Inverts the boolean value of the argument',
args: [{
type: 'boolean'
}]
Expand Down

0 comments on commit fd2049d

Please sign in to comment.