#9206: Improve documentation on raw SQL queries
-----------------------------------------------------------------------+----
          Reporter:  Richard Davies <[email protected]>  |        
 Owner:  nobody
            Status:  reopened                                          |     
Milestone:  1.1   
         Component:  Documentation                                     |       
Version:  SVN   
        Resolution:                                                    |      
Keywords:        
             Stage:  Accepted                                          |     
Has_patch:  1     
        Needs_docs:  0                                                 |   
Needs_tests:  0     
Needs_better_patch:  0                                                 |  
-----------------------------------------------------------------------+----
Comment (by russellm):

 This is better, but two comments:

  1. The versionadded flag doesn't render - you can't have a versionadded
 in between bullet points like you have used

  2. When discussing savepoints, you present an example. You have tried to
 keep the example simple, which is good - but as a result, it isn't obvious
 to me how savepoints are any different to normal rollbacks. This possibly
 points to a bigger problem - the fact that savepoints aren't documented
 anywhere (as far as I can make out). If there was a good block of
 savepoint documentation, you could just use a link to that documentation.
 If savepoint docs existed, you wouldn't need an example at all - you could
 just link to the relevant section and move on.

-- 
Ticket URL: <http://code.djangoproject.com/ticket/9206#comment:7>
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