summaryrefslogtreecommitdiff
path: root/docs/ref/utils.txt
diff options
context:
space:
mode:
authorGabriel Hurley <gabehr@gmail.com>2011-03-03 22:20:54 +0000
committerGabriel Hurley <gabehr@gmail.com>2011-03-03 22:20:54 +0000
commit4e76f0f79398d7ed7c1fea88b70f846e96c94de5 (patch)
tree64d3b46fa7937b467082ae2659ffc4f0742ce034 /docs/ref/utils.txt
parent136930085bb9e8ed434b6b9aeddd58e336f96f5e (diff)
Fixed #15504 -- Cleaned up contrib.syndication and contrib.utils.feedgenerator docs. Corrected numerous reST problems, removed duplicate method declarations, corrected method signatures, etc. Thanks to slinkp for the report.
git-svn-id: http://code.djangoproject.com/svn/django/trunk@15739 bcc190cf-cafb-0310-a4f2-bffc1f526a37
Diffstat (limited to 'docs/ref/utils.txt')
-rw-r--r--docs/ref/utils.txt22
1 files changed, 20 insertions, 2 deletions
diff --git a/docs/ref/utils.txt b/docs/ref/utils.txt
index 8a388fd70c..979c1867d1 100644
--- a/docs/ref/utils.txt
+++ b/docs/ref/utils.txt
@@ -229,6 +229,17 @@ SyndicationFeed
.. class:: SyndicationFeed
Base class for all syndication feeds. Subclasses should provide write().
+
+ .. method:: __init__(title, link, description, [language=None, author_email=None, author_name=None, author_link=None, subtitle=None, categories=None, feed_url=None, feed_copyright=None, feed_guid=None, ttl=None, **kwargs])
+
+ Initialize the feed with the given dictionary of metadata, which applies
+ to the entire feed.
+
+ Any extra keyword arguments you pass to ``__init__`` will be stored in
+ ``self.feed``.
+
+ All parameters should be Unicode objects, except ``categories``, which
+ should be a sequence of Unicode objects.
.. method:: add_item(title, link, description, [author_email=None, author_name=None, author_link=None, pubdate=None, comments=None, unique_id=None, enclosure=None, categories=(), item_copyright=None, ttl=None, **kwargs])
@@ -241,12 +252,12 @@ SyndicationFeed
.. method:: root_attributes()
Return extra attributes to place on the root (i.e. feed/channel)
- element. Called from write().
+ element. Called from ``write()``.
.. method:: add_root_elements(handler)
Add elements in the root (i.e. feed/channel) element.
- Called from write().
+ Called from ``write()``.
.. method:: item_attributes(item)
@@ -290,6 +301,13 @@ Rss201rev2Feed
Spec: http://blogs.law.harvard.edu/tech/rss
+RssUserland091Feed
+------------------
+
+.. class:: RssUserland091Feed(RssFeed)
+
+ Spec: http://backend.userland.com/rss091
+
Atom1Feed
---------