Anonymous avatar Anonymous committed 47faa1e

[1.1.X] Fixed #12997 -- Corrected the module markup for QuerySet methods. Thanks to timo for the report.

Backport of r13235 from trunk.

Comments (0)

Files changed (2)

docs/ref/models/querysets.txt

 QuerySet API reference
 ======================
 
-.. currentmodule:: django.db.models
+.. currentmodule:: django.db.models.QuerySet
 
 This document describes the details of the ``QuerySet`` API. It builds on the
 material presented in the :ref:`model <topics-db-models>` and :ref:`database

docs/ref/models/relations.txt

 Related objects reference
 =========================
 
-.. currentmodule:: django.db.models
+.. currentmodule:: django.db.models.fields.related
 
 This document describes extra methods available on managers when used in a one-to-many or many-to-many related context. This happens in two cases:
 
     * The "other side" of a ``ForeignKey`` relation. That is::
-    
+
             class Reporter(models.Model):
                 ...
-                
+
             class Article(models.Model):
                 reporter = models.ForeignKey(Reporter)
-            
+
       In the above example, the methods below will be available on
       the manager ``reporter.article_set``.
-      
+
     * Both sides of a ``ManyToManyField`` relation::
-    
+
             class Topping(models.Model):
                 ...
-                
+
             class Pizza(models.Model):
                 toppings = models.ManyToManyField(Topping)
-                
+
       In this example, the methods below will be available both on
       ``topping.pizza_set`` and on ``pizza.toppings``.
 
-.. method:: QuerySet.add(obj1, [obj2, ...])
+.. method:: add(obj1, [obj2, ...])
 
     Adds the specified model objects to the related object set.
 
         >>> e = Entry.objects.get(id=234)
         >>> b.entry_set.add(e) # Associates Entry e with Blog b.
 
-.. method:: QuerySet.create(**kwargs)
+.. method:: create(**kwargs)
 
     Creates a new object, saves it and puts it in the related object set.
     Returns the newly created object::
 
         >>> b = Blog.objects.get(id=1)
         >>> e = b.entry_set.create(
-        ...     headline='Hello', 
-        ...     body_text='Hi', 
+        ...     headline='Hello',
+        ...     body_text='Hi',
         ...     pub_date=datetime.date(2005, 1, 1)
         ... )
-        
+
         # No need to call e.save() at this point -- it's already been saved.
 
     This is equivalent to (but much simpler than)::
 
         >>> b = Blog.objects.get(id=1)
         >>> e = Entry(
-        ....     blog=b, 
-        ....     headline='Hello', 
-        ....     body_text='Hi', 
+        ....     blog=b,
+        ....     headline='Hello',
+        ....     body_text='Hi',
         ....     pub_date=datetime.date(2005, 1, 1)
         .... )
         >>> e.save(force_insert=True)
     ``blog`` to ``create()``. Django figures out that the new ``Entry`` object's
     ``blog`` field should be set to ``b``.
 
-.. method:: QuerySet.remove(obj1, [obj2, ...])
+.. method:: remove(obj1, [obj2, ...])
 
     Removes the specified model objects from the related object set::
-    
+
         >>> b = Blog.objects.get(id=1)
         >>> e = Entry.objects.get(id=234)
         >>> b.entry_set.remove(e) # Disassociates Entry e from Blog b.
     ``b.entry_set()`` is equivalent to doing ``e.blog = None``, and because the
     ``blog`` ``ForeignKey`` doesn't have ``null=True``, this is invalid.
 
-.. method:: QuerySet.clear()
+.. method:: clear()
 
     Removes all objects from the related object set::
 
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.