From 98ee57e343206ef553de78b22be5e9a6dacb5060 Mon Sep 17 00:00:00 2001 From: Josh Schneier Date: Wed, 19 Apr 2017 14:48:01 -0400 Subject: [PATCH] Removed nonexistent methods from File's docs. read() and write() were removed in 68a890e79f660484d05482902663b6168f0bd71e. --- docs/ref/files/file.txt | 19 ++++--------------- docs/ref/models/fields.txt | 7 +++---- 2 files changed, 7 insertions(+), 19 deletions(-) diff --git a/docs/ref/files/file.txt b/docs/ref/files/file.txt index d79ae57f47..a1f29ebf66 100644 --- a/docs/ref/files/file.txt +++ b/docs/ref/files/file.txt @@ -59,11 +59,6 @@ The ``File`` class Returns ``self``, so that it can be used similar to Python's built-in :func:`python:open()` with the ``with`` statement. - .. method:: read(num_bytes=None) - - Read content from the file. The optional ``size`` is the number of - bytes to read; if not specified, the file will be read to the end. - .. method:: __iter__() Iterate over the file yielding one line at a time. @@ -81,22 +76,16 @@ The ``File`` class Returns ``True`` if the file is large enough to require multiple chunks to access all of its content give some ``chunk_size``. - .. method:: write(content) - - Writes the specified content string to the file. Depending on the - storage system behind the scenes, this content might not be fully - committed until :func:`close()` is called on the file. - .. method:: close() Close the file. In addition to the listed methods, :class:`~django.core.files.File` exposes the following attributes and methods of its ``file`` object: - ``encoding``, ``fileno``, ``flush``, ``isatty``, ``newlines``, - ``read``, ``readinto``, ``readlines``, ``seek``, ``softspace``, ``tell``, - ``truncate``, ``writelines``, ``xreadlines``, ``readable()``, - ``writable()``, and ``seekable()``. + ``encoding``, ``fileno``, ``flush``, ``isatty``, ``newlines``, ``read``, + ``readinto``, ``readline``, ``readlines``, ``seek``, ``softspace``, + ``tell``, ``truncate``, ``write``, ``writelines``, ``xreadlines``, + ``readable()``, ``writable()``, and ``seekable()``. .. versionchanged:: 1.11 diff --git a/docs/ref/models/fields.txt b/docs/ref/models/fields.txt index 36b553f92c..e9e601e5c7 100644 --- a/docs/ref/models/fields.txt +++ b/docs/ref/models/fields.txt @@ -760,10 +760,9 @@ the result of the :attr:`Storage.open()` method, which may be a :class:`~django.core.files.File` object, or it may be a custom storage's implementation of the :class:`~django.core.files.File` API. -In addition to the API inherited from -:class:`~django.core.files.File` such as :meth:`~django.core.files.File.read` -and :meth:`~django.core.files.File.write`, :class:`FieldFile` includes several -methods that can be used to interact with the underlying file: +In addition to the API inherited from :class:`~django.core.files.File` such as +``read()`` and ``write()``, :class:`FieldFile` includes several methods that +can be used to interact with the underlying file: .. warning::