diff --git a/README.rst b/README.rst index 754f592e..50701321 100644 --- a/README.rst +++ b/README.rst @@ -59,7 +59,7 @@ Features Installation ------------ -To install requests, simply: +To install Requests, simply: .. code-block:: bash @@ -84,7 +84,7 @@ Contribute ---------- #. Check for open issues or open a fresh issue to start a discussion around a feature idea or a bug. There is a Contributor Friendly tag for issues that should be ideal for people who are not very familiar with the codebase yet. -#. Fork `the repository`_ on Github to start making your changes to the **master** branch (or branch off of it). +#. Fork `the repository`_ on GitHub to start making your changes to the **master** branch (or branch off of it). #. Write a test which shows that the bug was fixed or that the feature works as expected. #. Send a pull request and bug the maintainer until it gets merged and published. :) Make sure to add yourself to AUTHORS_. diff --git a/docs/api.rst b/docs/api.rst index 08cb1b8d..a1c2cb99 100644 --- a/docs/api.rst +++ b/docs/api.rst @@ -186,7 +186,7 @@ Licensing One key difference that has nothing to do with the API is a change in the license from the ISC_ license to the `Apache 2.0`_ license. The Apache 2.0 -license ensures that contributions to requests are also covered by the Apache +license ensures that contributions to Requests are also covered by the Apache 2.0 license. .. _ISC: http://opensource.org/licenses/ISC diff --git a/docs/dev/philosophy.rst b/docs/dev/philosophy.rst index 41649dae..2f8ca855 100644 --- a/docs/dev/philosophy.rst +++ b/docs/dev/philosophy.rst @@ -38,4 +38,4 @@ Linux Distro Packages Distributions have been made for many Linux repositories, including: Ubuntu, Debian, RHEL, and Arch. -These distributions are sometimes divergent forks, or are otherwise not kept up-to-date with the latest code and bugfixes. PyPI (and its mirrors) and GitHub are the official distribution sources; alternatives are not supported by the requests project. +These distributions are sometimes divergent forks, or are otherwise not kept up-to-date with the latest code and bugfixes. PyPI (and its mirrors) and GitHub are the official distribution sources; alternatives are not supported by the Requests project. diff --git a/docs/dev/todo.rst b/docs/dev/todo.rst index ec33b7fb..1f2216b5 100644 --- a/docs/dev/todo.rst +++ b/docs/dev/todo.rst @@ -6,7 +6,7 @@ Requests is under active development, and contributions are more than welcome! #. Check for open issues or open a fresh issue to start a discussion around a bug. There is a Contributor Friendly tag for issues that should be ideal for people who are not very familiar with the codebase yet. -#. Fork `the repository `_ on Github and start making your +#. Fork `the repository `_ on GitHub and start making your changes to a new branch. #. Write a test which shows that the bug was fixed. #. Send a pull request and bug the maintainer until it gets merged and published. :) @@ -46,7 +46,7 @@ Requests currently supports the following versions of Python: Support for Python 3.1 and 3.2 may be dropped at any time. -Google App Engine will never be officially supported. Pull requests for compatibility will be accepted, as long as they don't complicate the codebase. +Google App Engine will never be officially supported. Pull Requests for compatibility will be accepted, as long as they don't complicate the codebase. Are you crazy? diff --git a/docs/user/advanced.rst b/docs/user/advanced.rst index 246313fc..ca85a349 100644 --- a/docs/user/advanced.rst +++ b/docs/user/advanced.rst @@ -13,7 +13,7 @@ The Session object allows you to persist certain parameters across requests. It also persists cookies across all requests made from the Session instance. -A session object has all the methods of the main Requests API. +A Session object has all the methods of the main Requests API. Let's persist some cookies across requests:: @@ -27,7 +27,7 @@ Let's persist some cookies across requests:: Sessions can also be used to provide default data to the request methods. This -is done by providing data to the properties on a session object:: +is done by providing data to the properties on a Session object:: s = requests.Session() s.auth = ('user', 'pass') @@ -51,7 +51,7 @@ Request and Response Objects Whenever a call is made to requests.*() you are doing two major things. First, you are constructing a ``Request`` object which will be sent off to a server to request or query some resource. Second, a ``Response`` object is generated -once ``requests`` gets a response back from the server. The response object +once ``requests`` gets a response back from the server. The Response object contains all of the information returned by the server and also contains the ``Request`` object you created originally. Here is a simple request to get some very important information from Wikipedia's servers:: @@ -120,7 +120,7 @@ Requests can verify SSL certificates for HTTPS requests, just like a web browser >>> requests.get('https://kennethreitz.com', verify=True) requests.exceptions.SSLError: hostname 'kennethreitz.com' doesn't match either of '*.herokuapp.com', 'herokuapp.com' -I don't have SSL setup on this domain, so it fails. Excellent. Github does though:: +I don't have SSL setup on this domain, so it fails. Excellent. GitHub does though:: >>> requests.get('https://github.com', verify=True) diff --git a/docs/user/authentication.rst b/docs/user/authentication.rst index 6c213eaa..4b29007c 100644 --- a/docs/user/authentication.rst +++ b/docs/user/authentication.rst @@ -87,7 +87,7 @@ authentication. Some of the best have been brought together under the - NTLM_ If you want to use any of these forms of authentication, go straight to their -Github page and follow the instructions. +GitHub page and follow the instructions. New Forms of Authentication diff --git a/docs/user/install.rst b/docs/user/install.rst index 9a30168b..718c9c51 100644 --- a/docs/user/install.rst +++ b/docs/user/install.rst @@ -10,7 +10,7 @@ The first step to using any software package is getting it properly installed. Distribute & Pip ---------------- -Installing requests is simple with `pip `_:: +Installing Requests is simple with `pip `_:: $ pip install requests @@ -22,11 +22,11 @@ But, you really `shouldn't do that `_ is one of them:: +If the Cheeseshop (a.k.a. PyPI) is down, you can also install Requests from one +of the mirrors. `Crate.io `_ is one of them:: $ pip install -i http://simple.crate.io/ requests diff --git a/docs/user/quickstart.rst b/docs/user/quickstart.rst index 51c85efe..86e42d06 100644 --- a/docs/user/quickstart.rst +++ b/docs/user/quickstart.rst @@ -117,7 +117,7 @@ You can also access the response body as bytes, for non-text requests:: The ``gzip`` and ``deflate`` transfer-encodings are automatically decoded for you. For example, to create an image from binary data returned by a request, you can -use the following code: +use the following code:: >>> from PIL import Image >>> from StringIO import StringIO @@ -173,7 +173,7 @@ More complicated POST requests ------------------------------ Typically, you want to send some form-encoded data — much like an HTML form. -To do this, simply pass a dictionary to the `data` argument. Your +To do this, simply pass a dictionary to the ``data`` argument. Your dictionary of data will automatically be form-encoded when the request is made:: >>> payload = {'key1': 'value1', 'key2': 'value2'} @@ -343,7 +343,7 @@ Requests will automatically perform location redirection while using the GET and OPTIONS verbs. GitHub redirects all HTTP requests to HTTPS. We can use the ``history`` method -of the Response object to track redirection. Let's see what Github does:: +of the Response object to track redirection. Let's see what GitHub does:: >>> r = requests.get('http://github.com') >>> r.url @@ -353,8 +353,9 @@ of the Response object to track redirection. Let's see what Github does:: >>> r.history [] -The :class:`Response.history` list contains a list of the -:class:`Request` objects that were created in order to complete the request. The list is sorted from the oldest to the most recent request. +The :class:`Response.history` list contains the :class:`Request` objects that +were created in order to complete the request. The list is sorted from the +oldest to the most recent request. If you're using GET or OPTIONS, you can disable redirection handling with the ``allow_redirects`` parameter:: @@ -378,7 +379,7 @@ redirection as well:: Timeouts -------- -You can tell requests to stop waiting for a response after a given number of +You can tell Requests to stop waiting for a response after a given number of seconds with the ``timeout`` parameter:: >>> requests.get('http://github.com', timeout=0.001) @@ -389,7 +390,7 @@ seconds with the ``timeout`` parameter:: .. admonition:: Note: - ``timeout`` only effects the connection process itself, not the + ``timeout`` only affects the connection process itself, not the downloading of the response body.