From 81c13171a985b89f2af6682dbd1d4b8766cb9af7 Mon Sep 17 00:00:00 2001 From: Jorin Vogel Date: Wed, 2 Aug 2017 14:25:05 +0200 Subject: Add some missing doc comments As pointed out by the linter, some exported functions and types are missing doc comments. The linter warnings have been reduced from 194 to 116. Not all missing comments have been added in this commit though. --- media/mediaType.go | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'media') diff --git a/media/mediaType.go b/media/mediaType.go index 8946a9e83..bfeeeaa9f 100644 --- a/media/mediaType.go +++ b/media/mediaType.go @@ -26,7 +26,7 @@ const ( defaultDelimiter = "." ) -// A media type (also known as MIME type and content type) is a two-part identifier for +// Type (also known as MIME type and content type) is a two-part identifier for // file formats and format contents transmitted on the Internet. // For Hugo's use case, we use the top-level type name / subtype name + suffix. // One example would be image/jpeg+jpg @@ -39,7 +39,7 @@ type Type struct { Delimiter string `json:"delimiter"` // defaults to "." } -// FromTypeString creates a new Type given a type sring on the form MainType/SubType and +// FromString creates a new Type given a type sring on the form MainType/SubType and // an optional suffix, e.g. "text/html" or "text/html+html". func FromString(t string) (Type, error) { t = strings.ToLower(t) -- cgit v1.2.3