Syndication Feed docs incorrectly describe <link> tag.
|Reported by:||melinath||Owned by:||melinath|
|Cc:||Triage Stage:||Ready for checkin|
|Has patch:||yes||Needs documentation:||no|
|Needs tests:||no||Patch needs improvement:||no|
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.
Change History (8)
Changed 3 years ago by melinath
comment:1 Changed 3 years ago by aaugustin
- Needs documentation unset
- Needs tests unset
- Patch needs improvement unset
- Triage Stage changed from Unreviewed to Accepted