summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorNick Pope <nick.pope@flightdataservices.com>2020-04-16 10:26:33 +0100
committerGitHub <noreply@github.com>2020-04-16 11:26:33 +0200
commit058b38b43ea4726be2914ecc967b8fb1da47d995 (patch)
tree50911b2d7eb64defa654aa0908b5bbd1069d1450 /docs
parentdaabb102c059119504dc6c78a2e2dc62c9d572b8 (diff)
Improved message example in admin actions documentation.
Avoid partial string construction and make use of ``ngettext`` to show example of how to handle plural variants with translations. Also make use of ``messages.SUCCESS`` to highlight customizing the style of the message - in this case it better fits what the message is conveying.
Diffstat (limited to 'docs')
-rw-r--r--docs/ref/contrib/admin/actions.txt15
1 files changed, 9 insertions, 6 deletions
diff --git a/docs/ref/contrib/admin/actions.txt b/docs/ref/contrib/admin/actions.txt
index 9364c396b3..184a4d529a 100644
--- a/docs/ref/contrib/admin/actions.txt
+++ b/docs/ref/contrib/admin/actions.txt
@@ -189,16 +189,19 @@ provided by the admin.
For example, we can use ``self`` to flash a message to the user informing her
that the action was successful::
+ from django.contrib import messages
+ from django.utils.translation import ngettext
+
class ArticleAdmin(admin.ModelAdmin):
...
def make_published(self, request, queryset):
- rows_updated = queryset.update(status='p')
- if rows_updated == 1:
- message_bit = "1 story was"
- else:
- message_bit = "%s stories were" % rows_updated
- self.message_user(request, "%s successfully marked as published." % message_bit)
+ updated = queryset.update(status='p')
+ self.message_user(request, ngettext(
+ '%d story was successfully marked as published.',
+ '%d stories were successfully marked as published.',
+ updated,
+ ) % updated, messages.SUCCESS)
This make the action match what the admin itself does after successfully
performing an action: