Comment 4 for bug 175482

Revision history for this message
Mark Shuttleworth (sabdfl) wrote : Re: [Bug 175482] Re: Feed URL's and ID best practices are unclear

Leonard, the issue is not specific to the implementation in
Announcements. The issue is that the interfaces do not explain best
practice, so EVERY Launchpad developer who tries to implement Feeds is
going to get it wrong. First, the API naming should be improved, so that
things like link_alternate actually say what they are. Second, the
docstrings should be clearer. Third, one of the Feed implementations (I
woul dbe happy for it to be the Announcements one) should be designated
as a reference implementation, and LOTS of comments (paragraphs of them)
added. This way, people can cargo-cult that implementation, read the
comments, tweak and amend, and get it right.

W.r.t. the tag: url I was not trying to use a real URL fragment, I was
trying to ensure that the "announcements" space was separated from any
other space, so that someone who does an RSS feed for, for example bugs,
does not inadvertently clash in namespaces. The model we have used
elsewhere is that "namespaces" are indicated by +. That's why we have
/ubuntu/+source/apache. It means that "source" is not a distroseries,
it's a new namespace under distro.

Please feel free to update feeds/announcements.py accordingly, designate
it the reference implementation, and comment it in detail!

Thanks,
Mark