Skip to content

Commit 7ccca13

Browse files
author
FND
committed
Fixed various stylistic issues in documentation
1 parent a9726c4 commit 7ccca13

File tree

3 files changed

+79
-80
lines changed

3 files changed

+79
-80
lines changed

docs/foreword.rst

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -9,16 +9,16 @@ What does "micro" mean?
99
-----------------------
1010

1111
To me, the "micro" in microframework refers not only to the simplicity and
12-
small size of the framework, but also the fact that it does not make much
12+
small size of the framework, but also the fact that it does not make many
1313
decisions for you. While Flask does pick a templating engine for you, we
1414
won't make such decisions for your datastore or other parts.
1515

16-
For us however the term “micro” does not mean that the whole implementation
16+
However, to us the term “micro” does not mean that the whole implementation
1717
has to fit into a single Python file.
1818

1919
One of the design decisions with Flask was that simple tasks should be
20-
simple and not take up a lot of code and yet not limit yourself. Because
21-
of that we took a few design choices that some people might find
20+
simple; they should not take a lot of code and yet they should not limit you.
21+
Because of that we made a few design choices that some people might find
2222
surprising or unorthodox. For example, Flask uses thread-local objects
2323
internally so that you don't have to pass objects around from function to
2424
function within a request in order to stay threadsafe. While this is a
@@ -30,17 +30,17 @@ and provide you with a lot of tools to make it as pleasant as possible to
3030
work with them.
3131

3232
Flask is also based on convention over configuration, which means that
33-
many things are preconfigured. For example, by convention, templates and
34-
static files are in subdirectories within the Python source tree of the
35-
application. While this can be changed you usually don't have to.
33+
many things are preconfigured. For example, by convention templates and
34+
static files are stored in subdirectories within the application's Python source tree.
35+
While this can be changed you usually don't have to.
3636

37-
The main reason however why Flask is called a "microframework" is the idea
37+
The main reason Flask is called a "microframework" is the idea
3838
to keep the core simple but extensible. There is no database abstraction
3939
layer, no form validation or anything else where different libraries
40-
already exist that can handle that. However Flask knows the concept of
41-
extensions that can add this functionality into your application as if it
40+
already exist that can handle that. However Flask supports
41+
extensions to add such functionality to your application as if it
4242
was implemented in Flask itself. There are currently extensions for
43-
object relational mappers, form validation, upload handling, various open
43+
object-relational mappers, form validation, upload handling, various open
4444
authentication technologies and more.
4545

4646
Since Flask is based on a very solid foundation there is not a lot of code
@@ -71,7 +71,7 @@ cause security problems.
7171
The documentation will warn you about aspects of web development that
7272
require attention to security. Some of these security concerns
7373
are far more complex than one might think, and we all sometimes underestimate
74-
the likelihood that a vulnerability will be exploited, until a clever
74+
the likelihood that a vulnerability will be exploited - until a clever
7575
attacker figures out a way to exploit our applications. And don't think
7676
that your application is not important enough to attract an attacker.
7777
Depending on the kind of attack, chances are that automated bots are
@@ -88,8 +88,8 @@ support the new iteration of the Python programming language. While the
8888
situation is greatly improving there are still some issues that make it
8989
hard for us to switch over to Python 3 just now. These problems are
9090
partially caused by changes in the language that went unreviewed for too
91-
long, partially also because we have not quite worked out how the lower
92-
level API should change for the unicode differences in Python3.
91+
long, partially also because we have not quite worked out how the lower-
92+
level API should change to account for the Unicode differences in Python 3.
9393

9494
Werkzeug and Flask will be ported to Python 3 as soon as a solution for
9595
the changes is found, and we will provide helpful tips how to upgrade

docs/installation.rst

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,8 @@ Werkzeug is a toolkit for WSGI, the standard Python interface between web
99
applications and a variety of servers for both development and deployment.
1010
Jinja2 renders templates.
1111

12-
So how do you get all that on your computer quickly? There are many ways
13-
which this section will explain, but the most kick-ass method is
12+
So how do you get all that on your computer quickly? There are many ways,
13+
as this section will explain, but the most kick-ass method is
1414
virtualenv, so let's look at that first.
1515

1616
Either way, you will need Python 2.5 or higher to get started, so be sure
@@ -58,7 +58,7 @@ even in your package manager. If you use Ubuntu, try::
5858

5959
If you are on Windows and don't have the `easy_install` command, you must
6060
install it first. Check the :ref:`windows-easy-install` section for more
61-
information about how to do that. Once you have it installed, run the
61+
information on how to do that. Once you have it installed, run the
6262
same commands as above, but without the `sudo` prefix.
6363

6464
Once you have virtualenv installed, just fire up a shell and create
@@ -78,7 +78,7 @@ the corresponding environment. On OS X and Linux, do the following::
7878

7979
(Note the space between the dot and the script name. The dot means that
8080
this script should run in the context of the current shell. If this command
81-
does not work in your shell, try replacing the dot with ``source``)
81+
does not work in your shell, try replacing the dot with ``source``.)
8282

8383
If you are a Windows user, the following command is for you::
8484

@@ -95,15 +95,15 @@ your virtualenv::
9595
A few seconds later you are good to go.
9696

9797

98-
System Wide Installation
98+
System-Wide Installation
9999
------------------------
100100

101-
This is possible as well, but I do not recommend it. Just run
102-
`easy_install` with root rights::
101+
This is possible as well, though I do not recommend it. Just run
102+
`easy_install` with root privileges::
103103

104104
$ sudo easy_install Flask
105105

106-
(Run it in an Admin shell on Windows systems and without `sudo`).
106+
(Run it in an Admin shell on Windows systems and without `sudo`.)
107107

108108

109109
Living on the Edge
@@ -159,7 +159,7 @@ to the `PATH` environment variable. To do that, right-click on the
159159
"Computer" icon on the Desktop or in the Start menu, and choose
160160
"Properties". Then, on Windows Vista and Windows 7 click on "Advanced System
161161
settings"; on Windows XP, click on the "Advanced" tab instead. Then click
162-
on the "Environment variables" button and double click on the "Path"
162+
on the "Environment variables" button and double-click on the "Path"
163163
variable in the "System variables" section. There append the path of your
164164
Python interpreter's Scripts folder; make sure you delimit it from
165165
existing values with a semicolon. Assuming you are using Python 2.6 on

0 commit comments

Comments
 (0)