Skip to content


Subversion checkout URL

You can clone with
Download ZIP
Browse files

Edited docs/model-api.txt permalink changes from [4879]

git-svn-id: bcc190cf-cafb-0310-a4f2-bffc1f526a37
  • Loading branch information...
1 parent 99fbb7b commit da1d001ce1105fb3f34c07fa75018e8137e3ece5 @adrianholovaty adrianholovaty committed
Showing with 8 additions and 10 deletions.
  1. +8 −10 docs/model-api.txt
18 docs/model-api.txt
@@ -1307,13 +1307,13 @@ A few special cases to note about ``list_display``:
* Usually, elements of ``list_display`` that aren't actual database fields
can't be used in sorting (because Django does all the sorting at the
database level).
However, if an element of ``list_display`` represents a certain database
field, you can indicate this fact by setting the ``admin_order_field``
attribute of the item.
For example::
class Person(models.Model):
first_name = models.CharField(maxlength=50)
color_code = models.CharField(maxlength=6)
@@ -1325,7 +1325,7 @@ A few special cases to note about ``list_display``:
return '<span style="color: #%s;">%s</span>' % (self.color_code, self.first_name)
colored_first_name.allow_tags = True
colored_first_name.admin_order_field = 'first_name'
The above will tell Django to order by the ``first_name`` field when
trying to sort by ``colored_first_name`` in the admin.
@@ -1759,7 +1759,7 @@ in the URLConf file and in the model.
You can further decouple your models from the URLconf using the ``permalink``
decorator. This decorator is passed the view function, a list of positional
-parameters and (optionally) a dictionary of named parameters. Django then
+parameters and (optionally) a dictionary of named parameters. Django then
works out the correct full URL path using the URLconf, substituting the
parameters you have given into the URL. For example, if your URLconf
contained a line such as::
@@ -1774,11 +1774,9 @@ contained a line such as::
return ('people.views.details', [str(])
get_absolute_url = permalink(get_absolute_url)
+Similarly, if you had a URLconf entry that looked like::
-Similraly, if you had a URLconf entry that looked like::
- (r'/archive/(?P<year>\d{4})/(?P<month>\d{1,2})/(?P<day>\d{1,2})/$',
- archive_view)
+ (r'/archive/(?P<year>\d{4})/(?P<month>\d{1,2})/(?P<day>\d{1,2})/$', archive_view) could reference this using ``permalink()`` as follows::
@@ -1790,7 +1788,7 @@ Similraly, if you had a URLconf entry that looked like::
get_absolute_url = permalink(get_absolute_url)
Notice that we specify an empty sequence for the second argument in this case,
-since we're only wanting to pass in some keyword arguments.
+because we only want to pass keyword arguments, not named arguments.
In this way, you're tying the model's absolute URL to the view that is used
to display it, without repeating the URL information anywhere. You can still

0 comments on commit da1d001

Please sign in to comment.
Something went wrong with that request. Please try again.