summaryrefslogtreecommitdiff
path: root/docs/ref/utils.txt
diff options
context:
space:
mode:
authorTim Graham <timograham@gmail.com>2013-01-01 08:12:42 -0500
committerTim Graham <timograham@gmail.com>2013-01-02 18:50:00 -0500
commitbe1e006c581cc45ed48ae0b423e7a0a996d2199b (patch)
tree5e33669588d7c8d2a49d99f82ae87524d22a9455 /docs/ref/utils.txt
parent61c861546bdbae694f22e2c54e9ca0f42331cae1 (diff)
[1.5.x] Fixed #19516 - Fixed remaining broken links.
Added -n to sphinx builds to catch issues going forward. Backport of 9b5f64cc6e from master.
Diffstat (limited to 'docs/ref/utils.txt')
-rw-r--r--docs/ref/utils.txt19
1 files changed, 9 insertions, 10 deletions
diff --git a/docs/ref/utils.txt b/docs/ref/utils.txt
index 4ff31591c8..9d3e000e03 100644
--- a/docs/ref/utils.txt
+++ b/docs/ref/utils.txt
@@ -192,8 +192,7 @@ The functions defined in this module share the following properties:
Like ``decorator_from_middleware``, but returns a function
that accepts the arguments to be passed to the middleware_class.
For example, the :func:`~django.views.decorators.cache.cache_page`
- decorator is created from the
- :class:`~django.middleware.cache.CacheMiddleware` like this::
+ decorator is created from the ``CacheMiddleware`` like this::
cache_page = decorator_from_middleware_with_args(CacheMiddleware)
@@ -284,15 +283,15 @@ The functions defined in this module share the following properties:
.. function:: smart_str(s, encoding='utf-8', strings_only=False, errors='strict')
Alias of :func:`smart_bytes` on Python 2 and :func:`smart_text` on Python
- 3. This function returns a :class:`str` or a lazy string.
+ 3. This function returns a ``str`` or a lazy string.
- For instance, this is suitable for writing to :attr:`sys.stdout` on
+ For instance, this is suitable for writing to :data:`sys.stdout` on
Python 2 and 3.
.. function:: force_str(s, encoding='utf-8', strings_only=False, errors='strict')
Alias of :func:`force_bytes` on Python 2 and :func:`force_text` on Python
- 3. This function always returns a :class:`str`.
+ 3. This function always returns a ``str``.
.. function:: iri_to_uri(iri)
@@ -626,12 +625,12 @@ escaping HTML.
.. function:: base36_to_int(s)
Converts a base 36 string to an integer. On Python 2 the output is
- guaranteed to be an :class:`int` and not a :class:`long`.
+ guaranteed to be an ``int`` and not a ``long``.
.. function:: int_to_base36(i)
Converts a positive integer to a base 36 string. On Python 2 ``i`` must be
- smaller than :attr:`sys.maxint`.
+ smaller than :data:`sys.maxint`.
``django.utils.safestring``
===========================
@@ -649,12 +648,12 @@ appropriate entities.
.. versionadded:: 1.5
- A :class:`bytes` subclass that has been specifically marked as "safe"
+ A ``bytes`` subclass that has been specifically marked as "safe"
(requires no further escaping) for HTML output purposes.
.. class:: SafeString
- A :class:`str` subclass that has been specifically marked as "safe"
+ A ``str`` subclass that has been specifically marked as "safe"
(requires no further escaping) for HTML output purposes. This is
:class:`SafeBytes` on Python 2 and :class:`SafeText` on Python 3.
@@ -662,7 +661,7 @@ appropriate entities.
.. versionadded:: 1.5
- A :class:`str` (in Python 3) or :class:`unicode` (in Python 2) subclass
+ A ``str`` (in Python 3) or ``unicode`` (in Python 2) subclass
that has been specifically marked as "safe" for HTML output purposes.
.. class:: SafeUnicode