Opened 13 years ago
Closed 13 years ago
#16150 closed Bug (fixed)
Syndication Feed docs incorrectly describe <link> tag.
Reported by: | Stephen Burrows | Owned by: | Stephen Burrows |
---|---|---|---|
Component: | Documentation | Version: | dev |
Severity: | Normal | Keywords: | rss |
Cc: | Triage Stage: | Ready for checkin | |
Has patch: | yes | Needs documentation: | no |
Needs tests: | no | Patch needs improvement: | no |
Easy pickings: | yes | UI/UX: | no |
Description
The current docs use the language "feed's link" when referring to the dynamic "link" attribute, which is later used to generate the <link> element of the rss channel. However, according to the RSS spec, <link> is "The URL to the HTML website corresponding to the channel."
In Atom, the <link> element refers either to the corresponding HTML website or to the feed itself, depending on whether the rel attribute is set to "alternate" or "self" respectively. Django is consistent and uses the dynamic "link" attribute for alternate, reserving "feed_url" for the self reference.
So the docs are currently inaccurate. "link" is not used as the feed's url - it's used as the url of the website corresponding to the feed. The simplest way to fix it would be to change the language for the link dynamic attr docs. However, it would probably be good to add feed_url to the list of dynamic attrs, since the syndication code already looks for it.
Attachments (2)
Change History (8)
by , 13 years ago
Attachment: | syndication_docs.diff added |
---|
comment:1 by , 13 years ago
Triage Stage: | Unreviewed → Accepted |
---|
comment:2 by , 13 years ago
Status: | new → assigned |
---|---|
UI/UX: | unset |
comment:3 by , 13 years ago
Patch needs improvement: | set |
---|
by , 13 years ago
Attachment: | 16150_v2.diff added |
---|
comment:4 by , 13 years ago
Patch needs improvement: | unset |
---|
I improved the melinath
patch by appling aaugustin
advices.
comment:5 by , 13 years ago
Triage Stage: | Accepted → Ready for checkin |
---|
In the FEED_URL section, shouldn't
link = '/foo/bar/'
readfeed_url = '/foo/bar/'
instead?Also, I suggest using significant URLs to convey the difference: for instance,
link = '/blog/'
andfeed_url = '/blog/rss/
.