From 4115e88a7b2fe32e6a3d4b4c807239e21f5fc9ab Mon Sep 17 00:00:00 2001 From: Bruno Schaatsbergen <git@bschaatsbergen.com> Date: Mon, 1 Apr 2024 00:34:07 +0200 Subject: [PATCH] style: touch up names --- docs/functions/contains.md | 4 ++-- docs/functions/false.md | 6 +++--- docs/functions/not_null.md | 6 +++--- docs/functions/null.md | 6 +++--- docs/functions/true.md | 6 +++--- internal/provider/contains_function.go | 2 +- internal/provider/false_function.go | 6 +++--- internal/provider/not_null_function.go | 6 +++--- internal/provider/null_function.go | 6 +++--- internal/provider/true_function.go | 6 +++--- 10 files changed, 27 insertions(+), 27 deletions(-) diff --git a/docs/functions/contains.md b/docs/functions/contains.md index 6e2405c..50b7e03 100644 --- a/docs/functions/contains.md +++ b/docs/functions/contains.md @@ -16,12 +16,12 @@ description: |- <!-- signature generated by tfplugindocs --> ```text -contains(input list of string, string string) bool +contains(list list of string, string string) bool ``` ## Arguments <!-- arguments generated by tfplugindocs --> -1. `input` (List of String) The list of strings to check +1. `list` (List of String) The list of strings to check 1. `string` (String) The string to check for diff --git a/docs/functions/false.md b/docs/functions/false.md index 59e7854..6e40f6d 100644 --- a/docs/functions/false.md +++ b/docs/functions/false.md @@ -3,7 +3,7 @@ page_title: "false function - terraform-provider-assert" subcategory: "" description: |- - Checks whether a value is false + Checks whether a boolean value is false --- # function: false @@ -16,11 +16,11 @@ description: |- <!-- signature generated by tfplugindocs --> ```text -false(value bool) bool +false(bool bool) bool ``` ## Arguments <!-- arguments generated by tfplugindocs --> -1. `value` (Boolean) The value to check +1. `bool` (Boolean) The boolean value to check diff --git a/docs/functions/not_null.md b/docs/functions/not_null.md index c48a3ee..67f252d 100644 --- a/docs/functions/not_null.md +++ b/docs/functions/not_null.md @@ -3,7 +3,7 @@ page_title: "not_null function - terraform-provider-assert" subcategory: "" description: |- - Checks whether a given object is not null + Checks whether a given argument is not null --- # function: not_null @@ -16,11 +16,11 @@ description: |- <!-- signature generated by tfplugindocs --> ```text -not_null(object dynamic) bool +not_null(argument dynamic) bool ``` ## Arguments <!-- arguments generated by tfplugindocs --> -1. `object` (Dynamic, Nullable) The object to check +1. `argument` (Dynamic, Nullable) The argument to check diff --git a/docs/functions/null.md b/docs/functions/null.md index a351067..074b401 100644 --- a/docs/functions/null.md +++ b/docs/functions/null.md @@ -3,7 +3,7 @@ page_title: "null function - terraform-provider-assert" subcategory: "" description: |- - Checks whether a given object is null + Checks whether a given argument is null --- # function: null @@ -16,11 +16,11 @@ description: |- <!-- signature generated by tfplugindocs --> ```text -null(object dynamic) bool +null(argument dynamic) bool ``` ## Arguments <!-- arguments generated by tfplugindocs --> -1. `object` (Dynamic, Nullable) The object to check +1. `argument` (Dynamic, Nullable) The argument to check diff --git a/docs/functions/true.md b/docs/functions/true.md index 9d57a4b..14600eb 100644 --- a/docs/functions/true.md +++ b/docs/functions/true.md @@ -3,7 +3,7 @@ page_title: "true function - terraform-provider-assert" subcategory: "" description: |- - Checks whether a value is true + Checks whether a boolean value is true --- # function: true @@ -16,11 +16,11 @@ description: |- <!-- signature generated by tfplugindocs --> ```text -true(value bool) bool +true(bool bool) bool ``` ## Arguments <!-- arguments generated by tfplugindocs --> -1. `value` (Boolean) The value to check +1. `bool` (Boolean) The boolean value to check diff --git a/internal/provider/contains_function.go b/internal/provider/contains_function.go index 59a3bed..4791370 100644 --- a/internal/provider/contains_function.go +++ b/internal/provider/contains_function.go @@ -32,7 +32,7 @@ func (r ContainsFunction) Definition(_ context.Context, _ function.DefinitionReq AllowNullValue: false, AllowUnknownValues: false, Description: "The list of strings to check", - Name: "input", + Name: "list", ElementType: tpftypes.StringType, }, function.StringParameter{ diff --git a/internal/provider/false_function.go b/internal/provider/false_function.go index 8b3388c..581c31b 100644 --- a/internal/provider/false_function.go +++ b/internal/provider/false_function.go @@ -25,13 +25,13 @@ func (r FalseFunction) Metadata(_ context.Context, req function.MetadataRequest, func (r FalseFunction) Definition(_ context.Context, _ function.DefinitionRequest, resp *function.DefinitionResponse) { resp.Definition = function.Definition{ - Summary: "Checks whether a value is false", + Summary: "Checks whether a boolean value is false", Parameters: []function.Parameter{ function.BoolParameter{ AllowNullValue: false, AllowUnknownValues: false, - Description: "The value to check", - Name: "value", + Description: "The boolean value to check", + Name: "bool", }, }, Return: function.BoolReturn{}, diff --git a/internal/provider/not_null_function.go b/internal/provider/not_null_function.go index 7e8af7a..49f0c9b 100644 --- a/internal/provider/not_null_function.go +++ b/internal/provider/not_null_function.go @@ -26,13 +26,13 @@ func (r NotNullFunction) Metadata(_ context.Context, req function.MetadataReques func (r NotNullFunction) Definition(_ context.Context, _ function.DefinitionRequest, resp *function.DefinitionResponse) { resp.Definition = function.Definition{ - Summary: "Checks whether a given object is not null", + Summary: "Checks whether a given argument is not null", Parameters: []function.Parameter{ function.DynamicParameter{ AllowNullValue: true, AllowUnknownValues: true, - Description: "The object to check", - Name: "object", + Description: "The argument to check", + Name: "argument", }, }, Return: function.BoolReturn{}, diff --git a/internal/provider/null_function.go b/internal/provider/null_function.go index 18fe0b7..5fe5bf4 100644 --- a/internal/provider/null_function.go +++ b/internal/provider/null_function.go @@ -26,13 +26,13 @@ func (r IsNullFunction) Metadata(_ context.Context, req function.MetadataRequest func (r IsNullFunction) Definition(_ context.Context, _ function.DefinitionRequest, resp *function.DefinitionResponse) { resp.Definition = function.Definition{ - Summary: "Checks whether a given object is null", + Summary: "Checks whether a given argument is null", Parameters: []function.Parameter{ function.DynamicParameter{ AllowNullValue: true, AllowUnknownValues: true, - Description: "The object to check", - Name: "object", + Description: "The argument to check", + Name: "argument", }, }, Return: function.BoolReturn{}, diff --git a/internal/provider/true_function.go b/internal/provider/true_function.go index 231c0d0..faf2bb5 100644 --- a/internal/provider/true_function.go +++ b/internal/provider/true_function.go @@ -25,13 +25,13 @@ func (r TrueFunction) Metadata(_ context.Context, req function.MetadataRequest, func (r TrueFunction) Definition(_ context.Context, _ function.DefinitionRequest, resp *function.DefinitionResponse) { resp.Definition = function.Definition{ - Summary: "Checks whether a value is true", + Summary: "Checks whether a boolean value is true", Parameters: []function.Parameter{ function.BoolParameter{ AllowNullValue: false, AllowUnknownValues: false, - Description: "The value to check", - Name: "value", + Description: "The boolean value to check", + Name: "bool", }, }, Return: function.BoolReturn{},