Skip to content

Commit

Permalink
lint
Browse files Browse the repository at this point in the history
  • Loading branch information
kimdre committed Dec 9, 2024
1 parent cade94f commit 2f2cfe3
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 3 deletions.
4 changes: 3 additions & 1 deletion docs/functions/idna.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,9 @@ description: |-

# function: idna

idna converts a [IDN](https://en.wikipedia.org/wiki/Internationalized_domain_name) domain or domain label to its ASCII form (Punnycode). For example, `provider::hetznerdns::idna("bücher.example.com")` is "xn--bcher-kva.example.com", and `provider::hetznerdns::idna("golang")` is "golang". If an error is encountered it will return an error and a (partially) processed result.
idna converts a [IDN][1] domain or domain label to its ASCII form (Punnycode). For example, `provider::hetznerdns::idna("bücher.example.com")` is "xn--bcher-kva.example.com", and `provider::hetznerdns::idna("golang")` is "golang". If an error is encountered it will return an error and a (partially) processed result.

[1]: https://en.wikipedia.org/wiki/Internationalized_domain_name

## Example Usage

Expand Down
5 changes: 3 additions & 2 deletions internal/provider/idna_function.go
Original file line number Diff line number Diff line change
Expand Up @@ -26,10 +26,11 @@ func (r idnaFunction) Definition(_ context.Context, _ function.DefinitionRequest
resp.Definition = function.Definition{
Summary: "idna function",
Description: "idna converts a IDN domain or domain label to its ASCII form (Punnycode).",
MarkdownDescription: "idna converts a [IDN](https://en.wikipedia.org/wiki/Internationalized_domain_name) domain or domain label to its ASCII form (Punnycode). " +
MarkdownDescription: "idna converts a [IDN][1] domain or domain label to its ASCII form (Punnycode). " +
"For example, `provider::hetznerdns::idna(\"bücher.example.com\")` is " +
"\"xn--bcher-kva.example.com\", and `provider::hetznerdns::idna(\"golang\")` is \"golang\". " +
"If an error is encountered it will return an error and a (partially) processed result.",
"If an error is encountered it will return an error and a (partially) processed result.\n\n" +
"[1]: https://en.wikipedia.org/wiki/Internationalized_domain_name",
Parameters: []function.Parameter{
function.StringParameter{
Name: "domain",
Expand Down

0 comments on commit 2f2cfe3

Please sign in to comment.