Fix Github and GoDocs Markdown (#14)

* GH Markdown fixes

* Updated format for godoc
This commit is contained in:
Konstantin Chukhlomin 2020-02-04 11:39:47 -05:00 committed by GitHub
parent 10213c61ce
commit d88b4c6de7
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 108 additions and 108 deletions

4
doc.go
View File

@ -15,8 +15,8 @@
// logic required to comply with the specifications and ensure a compliant feed.
// A number of overrides occur to help with iTunes visibility of your episodes.
//
// Notably, the [Podcast.AddItem(i Item)](#Podcast.AddItem) function performs most
// of the heavy lifting by taking the [Item](#Item) input and performing
// Notably, the `Podcast.AddItem` function performs most
// of the heavy lifting by taking the `Item` input and performing
// validation, overrides and duplicate setters through the feed.
//
// Full detailed Examples of the API are at https://godoc.org/github.com/eduncan911/podcast.

View File

@ -87,7 +87,7 @@ func (i *Item) AddPubDate(datetime *time.Time) {
// Limit: 4000 characters
//
// Note that this field is a CDATA encoded field which allows for rich text
// such as html links: <a href="http://www.apple.com">Apple</a>.
// such as html links: `<a href="http://www.apple.com">Apple</a>`.
func (i *Item) AddSummary(summary string) {
count := utf8.RuneCountInString(summary)
if count > 4000 {

View File

@ -27,7 +27,7 @@ type IImage struct {
// ISummary is a 4000 character rich-text field for the itunes:summary tag.
//
// This is rendered as CDATA which allows for HTML tags such as <a href="">.
// This is rendered as CDATA which allows for HTML tags such as `<a href="">`.
type ISummary struct {
XMLName xml.Name `xml:"itunes:summary"`
Text string `xml:",cdata"`

View File

@ -113,46 +113,46 @@ func (p *Podcast) AddAtomLink(href string) {
// used and will invalidate the feed if deviated from the list. That list is
// as follows.
//
// Arts
// * Arts
// * Design
// * Fashion & Beauty
// * Food
// * Literature
// * Performing Arts
// * Visual Arts
// Business
// * Business
// * Business News
// * Careers
// * Investing
// * Management & Marketing
// * Shopping
// Comedy
// Education
// * Comedy
// * Education
// * Education Technology
// * Higher Education
// * K-12
// * Language Courses
// * Training
// Games & Hobbies
// * Games & Hobbies
// * Automotive
// * Aviation
// * Hobbies
// * Other Games
// * Video Games
// Government & Organizations
// * Government & Organizations
// * Local
// * National
// * Non-Profit
// * Regional
// Health
// * Health
// * Alternative Health
// * Fitness & Nutrition
// * Self-Help
// * Sexuality
// Kids & Family
// Music
// News & Politics
// Religion & Spirituality
// * Kids & Family
// * Music
// * News & Politics
// * Religion & Spirituality
// * Buddhism
// * Christianity
// * Hinduism
@ -160,26 +160,26 @@ func (p *Podcast) AddAtomLink(href string) {
// * Judaism
// * Other
// * Spirituality
// Science & Medicine
// * Science & Medicine
// * Medicine
// * Natural Sciences
// * Social Sciences
// Society & Culture
// * Society & Culture
// * History
// * Personal Journals
// * Philosophy
// * Places & Travel
// Sports & Recreation
// * Sports & Recreation
// * Amateur
// * College & High School
// * Outdoor
// * Professional
// Technology
// * Technology
// * Gadgets
// * Podcasting
// * Software How-To
// * Tech News
// TV & Film
// * TV & Film
func (p *Podcast) AddCategory(category string, subCategories []string) {
if len(category) == 0 {
return
@ -229,7 +229,7 @@ func (p *Podcast) AddImage(url string) {
// This method takes the "itunes overrides" approach to populating
// itunes tags according to the overrides rules in the specification.
// This not only complies completely with iTunes parsing rules; but, it also
// displays what is possible to be set on an individual episode level - if you
// displays what is possible to be set on an individual episode level if you
// wish to have more fine grain control over your content.
//
// This method imposes strict validation of the Item being added to confirm
@ -364,7 +364,7 @@ func (p *Podcast) AddSubTitle(subTitle string) {
// Limit: 4000 characters
//
// Note that this field is a CDATA encoded field which allows for rich text
// such as html links: <a href="http://www.apple.com">Apple</a>.
// such as html links: `<a href="http://www.apple.com">Apple</a>`.
func (p *Podcast) AddSummary(summary string) {
count := utf8.RuneCountInString(summary)
if count == 0 {