#15504: Incorrect docs for args to SyndicationFeed.add_item
--------------------------------------------+-------------------------------
               Reporter:  slinkp@…          |         Owner:  nobody
                 Status:  reopened          |     Milestone:        
              Component:  Documentation     |       Version:  1.2   
             Resolution:                    |      Keywords:        
           Triage Stage:  Unreviewed        |     Has patch:  0     
    Needs documentation:  0                 |   Needs tests:  0     
Patch needs improvement:  0                 |  
--------------------------------------------+-------------------------------
Changes (by slinkp@…):

  * status:  closed => reopened
  * resolution:  invalid =>
  * component:  Uncategorized => Documentation


Comment:

 Sorry, I may have confused things a bit by linking to both 1.2 and dev
 docs, my mistake.
 I was trying to say that the args are documented in two places in the
 docs, and they disagree.

 http://docs.djangoproject.com/en/dev/ref/utils/#syndicationfeed is
 correct.

 http://docs.djangoproject.com/en/dev/ref/contrib/syndication
 /#syndicationfeed-classes '''is wrong''', it says:
 {{{
 SyndicationFeed.add_item(**kwargs)

     Add an item to the feed with the given parameters.

     Required keyword arguments are:

         * title
         * link
         * description
 }}}

 That should be replaced by:

 {{{
 SyndicationFeed.add_item(title, link, description, **kwargs)

     Add an item to the feed with the given parameters.

 }}}

-- 
Ticket URL: <http://code.djangoproject.com/ticket/15504#comment:2>
Django <http://code.djangoproject.com/>
The Web framework for perfectionists with deadlines.

-- 
You received this message because you are subscribed to the Google Groups 
"Django updates" group.
To post to this group, send email to [email protected].
To unsubscribe from this group, send email to 
[email protected].
For more options, visit this group at 
http://groups.google.com/group/django-updates?hl=en.

Reply via email to