From 12761bd02ce8480c228008792861c8ce357d396a Mon Sep 17 00:00:00 2001 From: Jeffrey Finkelstein Date: Sun, 26 Jun 2011 21:43:48 -0400 Subject: [PATCH] fixed pronoun gender in documentation --- docs/api.rst | 4 ++-- docs/patterns/errorpages.rst | 4 ++-- docs/patterns/fileuploads.rst | 6 +++--- docs/patterns/flashing.rst | 2 +- docs/patterns/viewdecorators.rst | 2 +- docs/quickstart.rst | 8 ++++---- docs/security.rst | 2 +- docs/tutorial/views.rst | 2 +- 8 files changed, 15 insertions(+), 15 deletions(-) diff --git a/docs/api.rst b/docs/api.rst index 88d026ed..109e0317 100644 --- a/docs/api.rst +++ b/docs/api.rst @@ -156,8 +156,8 @@ If you have the :attr:`Flask.secret_key` set you can use sessions in Flask applications. A session basically makes it possible to remember information from one request to another. The way Flask does this is by using a signed cookie. So the user can look at the session contents, but -not modify it unless he knows the secret key, so make sure to set that to -something complex and unguessable. +not modify it unless he or she knows the secret key, so make sure to set that +to something complex and unguessable. To access the current session you can use the :class:`session` object: diff --git a/docs/patterns/errorpages.rst b/docs/patterns/errorpages.rst index 4041bd8a..babeae4f 100644 --- a/docs/patterns/errorpages.rst +++ b/docs/patterns/errorpages.rst @@ -24,7 +24,7 @@ even if the application behaves correctly: *403 Forbidden* If you have some kind of access control on your website, you will have to send a 403 code for disallowed resources. So make sure the user - is not lost when he tries to access a resource he cannot access. + is not lost when he or she tries to access a forbidden resource. *410 Gone* Did you know that there the "404 Not Found" has a brother named "410 @@ -32,7 +32,7 @@ even if the application behaves correctly: resources that previously existed and got deleted answer with 410 instead of 404. If you are not deleting documents permanently from the database but just mark them as deleted, do the user a favour and - use the 410 code instead and display a message that what he was + use the 410 code instead and display a message that what he or she was looking for was deleted for all eternity. *500 Internal Server Error* diff --git a/docs/patterns/fileuploads.rst b/docs/patterns/fileuploads.rst index 23d6c6bb..ab49cedb 100644 --- a/docs/patterns/fileuploads.rst +++ b/docs/patterns/fileuploads.rst @@ -89,7 +89,7 @@ before storing it directly on the filesystem. Assuming the number of ``../`` is correct and you would join this with the `UPLOAD_FOLDER` the user might have the ability to modify a file on - the server's filesystem he should not modify. This does require some + the server's filesystem he or she should not modify. This does require some knowledge about how the application looks like, but trust me, hackers are patient :) @@ -155,8 +155,8 @@ Upload Progress Bars A while ago many developers had the idea to read the incoming file in small chunks and store the upload progress in the database to be able to poll the progress with JavaScript from the client. Long story short: the -client asks the server every 5 seconds how much he has transmitted -already. Do you realize the irony? The client is asking for something he +client asks the server every 5 seconds how much it has transmitted +already. Do you realize the irony? The client is asking for something it should already know. Now there are better solutions to that work faster and more reliable. The diff --git a/docs/patterns/flashing.rst b/docs/patterns/flashing.rst index 3610944e..a8291612 100644 --- a/docs/patterns/flashing.rst +++ b/docs/patterns/flashing.rst @@ -4,7 +4,7 @@ Message Flashing ================ Good applications and user interfaces are all about feedback. If the user -does not get enough feedback he will probably end up hating the +does not get enough feedback he or she will probably end up hating the application. Flask provides a really simple way to give feedback to a user with the flashing system. The flashing system basically makes it possible to record a message at the end of a request and access it next diff --git a/docs/patterns/viewdecorators.rst b/docs/patterns/viewdecorators.rst index e99fc13e..9396fa91 100644 --- a/docs/patterns/viewdecorators.rst +++ b/docs/patterns/viewdecorators.rst @@ -8,7 +8,7 @@ functionality to one or more functions. The :meth:`~flask.Flask.route` decorator is the one you probably used already. But there are use cases for implementing your own decorator. For instance, imagine you have a view that should only be used by people that are logged in to. If a user -goes to the site and is not logged in, he should be redirected to the +goes to the site and is not logged in, he or she should be redirected to the login page. This is a good example of a use case where a decorator is an excellent solution. diff --git a/docs/quickstart.rst b/docs/quickstart.rst index 179ff2de..5c3f4411 100644 --- a/docs/quickstart.rst +++ b/docs/quickstart.rst @@ -126,7 +126,7 @@ Modern web applications have beautiful URLs. This helps people remember the URLs which is especially handy for applications that are used from mobile devices with slower network connections. If the user can directly go to the desired page without having to hit the index page it is more -likely he will like the page and come back next time. +likely he or she will like the page and come back next time. As you have seen above, the :meth:`~flask.Flask.route` decorator is used to bind a function to a URL. Here are some basic examples:: @@ -615,7 +615,7 @@ code use the :func:`~flask.abort` function. Here an example how this works:: this_is_never_executed() This is a rather pointless example because a user will be redirected from -the index to a page he cannot access (401 means access denied) but it +the index to a page he or she cannot access (401 means access denied) but it shows how that works. By default a black and white error page is shown for each error code. If @@ -642,7 +642,7 @@ Besides the request object there is also a second object called user from one request to the next. This is implemented on top of cookies for you and signs the cookies cryptographically. What this means is that the user could look at the contents of your cookie but not modify it, -unless he knows the secret key used for signing. +unless he or she knows the secret key used for signing. In order to use sessions you have to set a secret key. Here is how sessions work:: @@ -698,7 +698,7 @@ Message Flashing ---------------- Good applications and user interfaces are all about feedback. If the user -does not get enough feedback he will probably end up hating the +does not get enough feedback he or she will probably end up hating the application. Flask provides a really simple way to give feedback to a user with the flashing system. The flashing system basically makes it possible to record a message at the end of a request and access it next diff --git a/docs/security.rst b/docs/security.rst index 07a5b942..0e6ff67e 100644 --- a/docs/security.rst +++ b/docs/security.rst @@ -73,7 +73,7 @@ them knowing. Say you have a specific URL that, when you sent `POST` requests to will delete a user's profile (say `http://example.com/user/delete`). If an attacker now creates a page that sends a post request to that page with -some JavaScript he just has to trick some users to load that page and +some JavaScript he or she just has to trick some users to load that page and their profiles will end up being deleted. Imagine you were to run Facebook with millions of concurrent users and diff --git a/docs/tutorial/views.rst b/docs/tutorial/views.rst index f2871257..466812dc 100644 --- a/docs/tutorial/views.rst +++ b/docs/tutorial/views.rst @@ -29,7 +29,7 @@ The view function will pass the entries as dicts to the Add New Entry ------------- -This view lets the user add new entries if he's logged in. This only +This view lets the user add new entries if he or she is logged in. This only responds to `POST` requests, the actual form is shown on the `show_entries` page. If everything worked out well we will :func:`~flask.flash` an information message to the next request and