[Python-checkins] cpython (merge 3.2 -> 3.3): Fix Issue17069: Document getcode method in urllib.request.rst

[senthil.kumaran]

http://hg.python.org/cpython/rev/e15d2ad42d93
changeset:   82036:e15d2ad42d93
branch:      3.3
parent:      82031:4db932a303b4
parent:      82035:fae8e212e870
user:        Senthil Kumaran <senthil at uthcode.com>
date:        Thu Feb 07 00:49:12 2013 -0800
summary:
  Fix Issue17069: Document getcode method in urllib.request.rst

files:
  Doc/library/urllib.request.rst |  16 ++++++++++++----
  1 files changed, 12 insertions(+), 4 deletions(-)


diff --git a/Doc/library/urllib.request.rst b/Doc/library/urllib.request.rst
--- a/Doc/library/urllib.request.rst
+++ b/Doc/library/urllib.request.rst
@@ -63,16 +63,24 @@
       an HTTPS request will not do any verification of the server's
       certificate.
 
-   This function returns a file-like object that works as a :term:`context manager`,
-   with two additional methods from the :mod:`urllib.response` module
+   For http and https urls, this function returns a
+   :class:`http.client.HTTPResponse` object which has the following
+   :ref:`httpresponse-objects` methods.
 
-   * :meth:`geturl` --- return the URL of the resource retrieved,
+   For ftp, file, data urls and requests are explicity handled by legacy
+   :class:`URLopener` and :class:`FancyURLopener` class, this function returns
+   an :class:`urllib.response.addinfourl` object which can work as
+   :term:`context manager` and has methods such as
+
+   * :meth:`~urllib.response.addinfourl.geturl` --- return the URL of the resource retrieved,
      commonly used to determine if a redirect was followed
 
-   * :meth:`info` --- return the meta-information of the page, such as headers,
+   * :meth:`~urllib.response.addinfourl.info` --- return the meta-information of the page, such as headers,
      in the form of an :func:`email.message_from_string` instance (see
      `Quick Reference to HTTP Headers <http://www.cs.tut.fi/~jkorpela/http.html>`_)
 
+   * :meth:`~urllib.response.addinfourl.getcode` -- return the HTTP status code of the response.
+
    Raises :exc:`URLError` on errors.
 
    Note that ``None`` may be returned if no handler handles the request (though

-- 
Repository URL: http://hg.python.org/cpython