From 899df4f5575ba4af3b6f26c3f5fe2b535213291d Mon Sep 17 00:00:00 2001 From: CodeLingo Bot Date: Mon, 18 Feb 2019 22:08:55 +0000 Subject: [PATCH] Fix function comments based on best practices from Effective Go Signed-off-by: CodeLingo Bot --- atom.go | 4 ++-- feed.go | 6 +++--- rss.go | 4 ++-- 3 files changed, 7 insertions(+), 7 deletions(-) diff --git a/atom.go b/atom.go index 9a4885b..7196f47 100644 --- a/atom.go +++ b/atom.go @@ -158,12 +158,12 @@ func (a *Atom) AtomFeed() *AtomFeed { return feed } -// return an XML-Ready object for an Atom object +// FeedXml returns an XML-Ready object for an Atom object func (a *Atom) FeedXml() interface{} { return a.AtomFeed() } -// return an XML-ready object for an AtomFeed object +// FeedXml returns an XML-ready object for an AtomFeed object func (a *AtomFeed) FeedXml() interface{} { return a } diff --git a/feed.go b/feed.go index 3474289..790a1b6 100644 --- a/feed.go +++ b/feed.go @@ -85,7 +85,7 @@ func ToXML(feed XmlFeed) (string, error) { return s, nil } -// Write a feed object (either a Feed, AtomFeed, or RssFeed) as XML into +// WriteXML writes a feed object (either a Feed, AtomFeed, or RssFeed) as XML into // the writer. Returns an error if XML marshaling fails. func WriteXML(feed XmlFeed, w io.Writer) error { x := feed.FeedXml() @@ -104,7 +104,7 @@ func (f *Feed) ToAtom() (string, error) { return ToXML(a) } -// Writes an Atom representation of this feed to the writer. +// WriteAtom writes an Atom representation of this feed to the writer. func (f *Feed) WriteAtom(w io.Writer) error { return WriteXML(&Atom{f}, w) } @@ -115,7 +115,7 @@ func (f *Feed) ToRss() (string, error) { return ToXML(r) } -// Writes an RSS representation of this feed to the writer. +// WriteRss writes an RSS representation of this feed to the writer. func (f *Feed) WriteRss(w io.Writer) error { return WriteXML(&Rss{f}, w) } diff --git a/rss.go b/rss.go index aaadbdb..09179df 100644 --- a/rss.go +++ b/rss.go @@ -151,14 +151,14 @@ func (r *Rss) RssFeed() *RssFeed { return channel } -// return an XML-Ready object for an Rss object +// FeedXml returns an XML-Ready object for an Rss object func (r *Rss) FeedXml() interface{} { // only generate version 2.0 feeds for now return r.RssFeed().FeedXml() } -// return an XML-ready object for an RssFeed object +// FeedXml returns an XML-ready object for an RssFeed object func (r *RssFeed) FeedXml() interface{} { return &RssFeedXml{ Version: "2.0",