docs: add per-function godoc to h element & attribute constructors#101
Merged
Conversation
The bulk element constructors and attribute shorthands relied on a single detached group comment, so `go doc` reported them as undocumented (only the first func in each block attached the comment). Add a one-line doc comment to each so every exported function in package h is documented.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Every exported function in package
hnow has a godoc comment.The bulk element constructors and attribute shorthands relied on a single detached group comment, so
go doc A/go doc Typereported them as undocumented — only the first func in each block attached the comment. Go can't group-document separate top-level funcs, so each gets a one-line doc.elements.go—// A renders the HTML <a> element.(void elements noted)attributes.go—// Href emits the href attribute.(group comment retained as Href's lead paragraph)build + vet pass; no remaining undocumented exported decls.