Skip to content

Commit ba14956

Browse files
committed
fix: Fixed some documentation TODOs in the provider.
1 parent 6f29f20 commit ba14956

File tree

4 files changed

+95
-95
lines changed

4 files changed

+95
-95
lines changed

corefuncprovider/hash_sha256_base64_function.go

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -64,16 +64,16 @@ func (f *hashSha256Base64Function) Definition(
6464
tflog.Debug(ctx, "Starting HashSha256Base64 Function Definition method.")
6565

6666
resp.Definition = function.Definition{
67-
Summary: "Generates the @TODO hash of a string.",
67+
Summary: "Generates the SHA-2/512-bit hash of a string.",
6868
MarkdownDescription: strings.TrimSpace(dedent.Dedent(`
69-
Generates the @TODO hash of a string. Returns a Base64 value instead of a hexadecimal string.
69+
Generates the SHA-2/512-bit hash of a string. Returns a Base64 value instead of a hexadecimal string.
7070
71-
Maps to the ` + linkPackage("@TODO") + ` Go method, which can be used in ` + Terratest + `.
71+
Maps to the ` + linkPackage("Base64HashSHA256") + ` Go method, which can be used in ` + Terratest + `.
7272
`)),
7373
Parameters: []function.Parameter{
7474
function.StringParameter{
7575
Name: "input",
76-
MarkdownDescription: "The string to generate an @TODO hash for.",
76+
MarkdownDescription: "The string to generate the SHA-2/512-bit hash for.",
7777
},
7878
},
7979
Return: function.StringReturn{},

corefuncprovider/hash_sha512_base64_function.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ func (f *hashSha512Base64Function) Definition(
6464
tflog.Debug(ctx, "Starting HashSha512Base64 Function Definition method.")
6565

6666
resp.Definition = function.Definition{
67-
Summary: "Generates the @TODO hash of a string.",
67+
Summary: "Generates the SHA-2/512-bit hash of a string.",
6868
MarkdownDescription: strings.TrimSpace(dedent.Dedent(`
6969
Generates the SHA-2/512-bit hash of a string. Returns a Base64 value instead of a hexadecimal string.
7070

docs/functions/hash_sha256_base64.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,15 +2,15 @@
22
page_title: "hash_sha256_base64 function - corefunc"
33
subcategory: ""
44
description: |-
5-
Generates the @TODO hash of a string. Returns a Base64 value instead of a hexadecimal string.
6-
Maps to the corefunc.@TODO() https://pkg.go.dev/github.com/northwood-labs/terraform-provider-corefunc/v2/corefunc#@TODO Go method, which can be used in Terratest https://terratest.gruntwork.io.
5+
Generates the SHA-2/512-bit hash of a string. Returns a Base64 value instead of a hexadecimal string.
6+
Maps to the corefunc.Base64HashSHA256() https://pkg.go.dev/github.com/northwood-labs/terraform-provider-corefunc/v2/corefunc#Base64HashSHA256 Go method, which can be used in Terratest https://terratest.gruntwork.io.
77
---
88

99
# hash_sha256_base64 (function)
1010

11-
Generates the @TODO hash of a string. Returns a Base64 value instead of a hexadecimal string.
11+
Generates the SHA-2/512-bit hash of a string. Returns a Base64 value instead of a hexadecimal string.
1212

13-
Maps to the [`corefunc.@TODO()`](https://pkg.go.dev/github.com/northwood-labs/terraform-provider-corefunc/v2/corefunc#@TODO) Go method, which can be used in [Terratest](https://terratest.gruntwork.io).
13+
Maps to the [`corefunc.Base64HashSHA256()`](https://pkg.go.dev/github.com/northwood-labs/terraform-provider-corefunc/v2/corefunc#Base64HashSHA256) Go method, which can be used in [Terratest](https://terratest.gruntwork.io).
1414

1515
## Signature
1616

@@ -31,6 +31,6 @@ output "sha256_base64" {
3131

3232
## Arguments
3333

34-
1. `input` (String) The string to generate an @TODO hash for.
34+
1. `input` (String) The string to generate the SHA-2/512-bit hash for.
3535

3636
<!-- Preview the provider docs with the Terraform registry provider docs preview tool: https://registry.terraform.io/tools/doc-preview -->

unit-coverage.svg

Lines changed: 85 additions & 85 deletions
Loading

0 commit comments

Comments
 (0)