diff options
author | Jorin Vogel <hi@jorin.me> | 2017-08-02 15:25:05 +0300 |
---|---|---|
committer | Bjørn Erik Pedersen <bjorn.erik.pedersen@gmail.com> | 2017-08-03 16:57:51 +0300 |
commit | 81c13171a985b89f2af6682dbd1d4b8766cb9af7 (patch) | |
tree | db39d78bbe6da0ea3f3dd3d2f94c7e1571ad8fd6 /hugolib/page_output.go | |
parent | 9891c0fb0eb274b8a95b62c40070a87a6e04088c (diff) |
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.
Diffstat (limited to 'hugolib/page_output.go')
-rw-r--r-- | hugolib/page_output.go | 6 |
1 files changed, 3 insertions, 3 deletions
diff --git a/hugolib/page_output.go b/hugolib/page_output.go index 6ea466b4f..3b1e07907 100644 --- a/hugolib/page_output.go +++ b/hugolib/page_output.go @@ -179,7 +179,7 @@ func (p *Page) checkRender() bool { // OutputFormats holds a list of the relevant output formats for a given resource. type OutputFormats []*OutputFormat -// And OutputFormat links to a representation of a resource. +// OutputFormat links to a representation of a resource. type OutputFormat struct { // Rel constains a value that can be used to construct a rel link. // This is value is fetched from the output format definition. @@ -227,7 +227,7 @@ func newOutputFormat(p *Page, f output.Format) *OutputFormat { return &OutputFormat{Rel: rel, f: f, p: p} } -// OutputFormats gives the alternative output formats for this PageOutput. +// AlternativeOutputFormats gives the alternative output formats for this PageOutput. // Note that we use the term "alternative" and not "alternate" here, as it // does not necessarily replace the other format, it is an alternative representation. func (p *PageOutput) AlternativeOutputFormats() (OutputFormats, error) { @@ -266,7 +266,7 @@ func (o *OutputFormat) Permalink() string { return perm } -// Permalink returns the relative permalink to this output format. +// RelPermalink returns the relative permalink to this output format. func (o *OutputFormat) RelPermalink() string { rel := o.p.createRelativePermalinkForOutputFormat(o.f) return o.p.s.PathSpec.PrependBasePath(rel) |