From 0a9bd266ff8e042f53e25928527a29ce896b4955 Mon Sep 17 00:00:00 2001 From: Adam Chainz Date: Fri, 23 Dec 2016 00:16:26 +0000 Subject: [PATCH] Documented url()'s 'regex' parameter. --- docs/ref/urls.txt | 7 +++++++ docs/topics/i18n/translation.txt | 1 + 2 files changed, 8 insertions(+) diff --git a/docs/ref/urls.txt b/docs/ref/urls.txt index 37df9a30cf..d1464da66d 100644 --- a/docs/ref/urls.txt +++ b/docs/ref/urls.txt @@ -33,6 +33,13 @@ Helper function to return a URL pattern for serving files in debug mode:: ... ] +The ``regex`` parameter should be a string or +:func:`~django.utils.translation.ugettext_lazy()` (see +:ref:`translating-urlpatterns`) that contains a regular expression compatible +with Python's :py:mod:`re` module. Strings typically use raw string syntax +(``r''``) so that they can contain sequences like ``\d`` without the need to +escape the backslash with another backslash. + The ``view`` parameter is a view function or the result of :meth:`~django.views.generic.base.View.as_view` for class-based views. It can also be an :func:`include`. diff --git a/docs/topics/i18n/translation.txt b/docs/topics/i18n/translation.txt index 1fa0cec547..aa85aff907 100644 --- a/docs/topics/i18n/translation.txt +++ b/docs/topics/i18n/translation.txt @@ -1533,6 +1533,7 @@ will be:: Ensure that you don't have non-prefixed URL patterns that might collide with an automatically-added language prefix. +.. _translating-urlpatterns: Translating URL patterns ------------------------