Skip to content

Commit

Permalink
Avoid raw URLs in maintainer tables
Browse files Browse the repository at this point in the history
Markdown linters like markdownlint fail by default on raw URLs. Wrap
maintainer table URLs in angle brackets to follow this norm and avoid
failures.

Signed-off-by: Daniel Farrell <dfarrell@redhat.com>
  • Loading branch information
dfarrell07 committed Jun 25, 2021
1 parent aaec4ec commit 752c76a
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion pkg/document/template.go
Original file line number Diff line number Diff line change
Expand Up @@ -128,7 +128,7 @@ func getMaintainersTemplate() string {
maintainerBuilder.WriteString("| Name | Email | Url |\n")
maintainerBuilder.WriteString("| ---- | ------ | --- |\n")
maintainerBuilder.WriteString(" {{- range .Maintainers }}")
maintainerBuilder.WriteString("\n| {{ .Name }} | {{ .Email }} | {{ .Url }} |")
maintainerBuilder.WriteString("\n| {{ .Name }} | {{ .Email }} | <{{ .Url }}> |")
maintainerBuilder.WriteString(" {{- end }}")
maintainerBuilder.WriteString("{{ end }}")

Expand Down

0 comments on commit 752c76a

Please sign in to comment.