Changeset 1025

Timestamp:

10/30/05 08:35:44 (3 years ago)

Author:

jacob

Message:

Documented singular argument for m2m relationships (fixes #664).

Files:

• django/trunk/docs/model-api.txt (modified) (1 diff)

django/trunk/docs/model-api.txt

@@ -622 +622 @@
-
-    ``limit_choices_to``     See the description under ``ForeignKey`` above.
+
+    ``singular``             The singular name of the field.  Use to name the ``get_*``
+                             methods: in the example above, Django gives the ``Pizza``
+                             objects a ``get_topping_list()`` method, where ``topping``
+                             is the default ``singular`` value derived from the lowercase
+                             version of the class being linked to.  Use the singular
+                             parameter to change this, which is if you want one model to
+                             have multiple ``ManyToMany`` relationships to another model.
-    =======================  ============================================================
-