Skip to content

Commit

Permalink
Replace HTML entities in function descriptions (hashicorp#32710)
Browse files Browse the repository at this point in the history
  • Loading branch information
dbanck authored and kmoe committed Mar 1, 2023
1 parent f1849c8 commit 84af8d1
Showing 1 changed file with 8 additions and 8 deletions.
16 changes: 8 additions & 8 deletions internal/lang/funcs/descriptions.go
Original file line number Diff line number Diff line change
Expand Up @@ -31,11 +31,11 @@ var DescriptionList = map[string]descriptionEntry{
ParamDescription: []string{""},
},
"alltrue": {
Description: "`alltrue` returns `true` if all elements in a given collection are `true` or `"true"`. It also returns `true` if the collection is empty.",
Description: "`alltrue` returns `true` if all elements in a given collection are `true` or `\"true\"`. It also returns `true` if the collection is empty.",
ParamDescription: []string{""},
},
"anytrue": {
Description: "`anytrue` returns `true` if any element in a given collection is `true` or `"true"`. It also returns `false` if the collection is empty.",
Description: "`anytrue` returns `true` if any element in a given collection is `true` or `\"true\"`. It also returns `false` if the collection is empty.",
ParamDescription: []string{""},
},
"base64decode": {
Expand All @@ -51,11 +51,11 @@ var DescriptionList = map[string]descriptionEntry{
ParamDescription: []string{""},
},
"base64sha256": {
Description: "`base64sha256` computes the SHA256 hash of a given string and encodes it with Base64. This is not equivalent to `base64encode(sha256("test"))` since `sha256()` returns hexadecimal representation.",
Description: "`base64sha256` computes the SHA256 hash of a given string and encodes it with Base64. This is not equivalent to `base64encode(sha256(\"test\"))` since `sha256()` returns hexadecimal representation.",
ParamDescription: []string{""},
},
"base64sha512": {
Description: "`base64sha512` computes the SHA512 hash of a given string and encodes it with Base64. This is not equivalent to `base64encode(sha512("test"))` since `sha512()` returns hexadecimal representation.",
Description: "`base64sha512` computes the SHA512 hash of a given string and encodes it with Base64. This is not equivalent to `base64encode(sha512(\"test\"))` since `sha512()` returns hexadecimal representation.",
ParamDescription: []string{""},
},
"basename": {
Expand Down Expand Up @@ -116,11 +116,11 @@ var DescriptionList = map[string]descriptionEntry{
},
},
"coalesce": {
Description: "`coalesce` takes any number of arguments and returns the first one that isn't null or an empty string.",
Description: "`coalesce` takes any number of arguments and returns the first one that isn't null or an empty string.",
ParamDescription: []string{""},
},
"coalescelist": {
Description: "`coalescelist` takes any number of list arguments and returns the first one that isn't empty.",
Description: "`coalescelist` takes any number of list arguments and returns the first one that isn't empty.",
ParamDescription: []string{
"List or tuple values to test in the given order.",
},
Expand Down Expand Up @@ -306,7 +306,7 @@ var DescriptionList = map[string]descriptionEntry{
ParamDescription: []string{"", ""},
},
"pathexpand": {
Description: "`pathexpand` takes a filesystem path that might begin with a `~` segment, and if so it replaces that segment with the current user's home directory path.",
Description: "`pathexpand` takes a filesystem path that might begin with a `~` segment, and if so it replaces that segment with the current user's home directory path.",
ParamDescription: []string{""},
},
"pow": {
Expand Down Expand Up @@ -499,7 +499,7 @@ var DescriptionList = map[string]descriptionEntry{
ParamDescription: []string{},
},
"uuidv5": {
Description: "`uuidv5` generates a _name-based_ UUID, as described in [RFC 4122 section 4.3](https://tools.ietf.org/html/rfc4122#section-4.3), also known as a "version 5" UUID.",
Description: "`uuidv5` generates a _name-based_ UUID, as described in [RFC 4122 section 4.3](https://tools.ietf.org/html/rfc4122#section-4.3), also known as a \"version 5\" UUID.",
ParamDescription: []string{"", ""},
},
"values": {
Expand Down

0 comments on commit 84af8d1

Please sign in to comment.