orbit-oss/flask
4
4
Fork 2
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Minor tutorial documentation fixes (grammar, etc)

Browse source
This commit is contained in:
Adam Zapletal 2010-06-28 11:10:07 +08:00 • committed by Armin Ronacher
parent 87c2c79442
commit 5ede53066f
2 changed files with 16 additions and 16 deletions
Download patch file Download diff file Expand all files Collapse all files

4
docs/tutorial/setup.rst
View file

@ -52,7 +52,7 @@ The `secret_key` is needed to keep the client-side sessions secure.
Choose that key wisely and as hard to guess and complex as possible. The Choose that key wisely and as hard to guess and complex as possible. The
debug flag enables or disables the interactive debugger. Never leave debug flag enables or disables the interactive debugger. Never leave
debug mode activated in a production system because it will allow users to debug mode activated in a production system because it will allow users to
executed code on the server! execute code on the server!
We also add a method to easily connect to the database specified. That We also add a method to easily connect to the database specified. That
can be used to open a connection on request and also from the interactive can be used to open a connection on request and also from the interactive
@ -64,7 +64,7 @@ Python shell or a script. This will come in handy later
return sqlite3.connect(app.config['DATABASE']) return sqlite3.connect(app.config['DATABASE'])
Finally we just add a line to the bottom of the file that fires up the Finally we just add a line to the bottom of the file that fires up the
server if we run that file as standalone application:: server if we want to run that file as a standalone application::
if __name__ == '__main__': if __name__ == '__main__':
app.run() app.run()

28
docs/tutorial/views.rst
View file

@ -11,11 +11,11 @@ Show Entries
This view shows all the entries stored in the database. It listens on the This view shows all the entries stored in the database. It listens on the
root of the application and will select title and text from the database. root of the application and will select title and text from the database.
The one with the highest id (the newest entry) on top. The rows returned The one with the highest id (the newest entry) will be on top. The rows
from the cursor are tuples with the columns ordered like specified in the returned from the cursor are tuples with the columns ordered like specified
select statement. This is good enough for small applications like here, in the select statement. This is good enough for small applications like
but you might want to convert them into a dict. If you are interested how here, but you might want to convert them into a dict. If you are
to do that, check out the :ref:`easy-querying` example. interested in how to do that, check out the :ref:`easy-querying` example.
The view function will pass the entries as dicts to the The view function will pass the entries as dicts to the
`show_entries.html` template and return the rendered one:: `show_entries.html` template and return the rendered one::
@ -53,11 +53,11 @@ Login and Logout
These functions are used to sign the user in and out. Login checks the These functions are used to sign the user in and out. Login checks the
username and password against the ones from the configuration and sets the username and password against the ones from the configuration and sets the
`logged_in` key in the session. If the user logged in successfully that `logged_in` key in the session. If the user logged in successfully, that
key is set to `True` and the user is redirected back to the `show_entries` key is set to `True`, and the user is redirected back to the `show_entries`
page. In that case also a message is flashed that informs the user he or page. In addition, a message is flashed that informs the user that he or
she was logged in successfully. If an error occoured the template is she was logged in successfully. If an error occurred, the template is
notified about that and the user asked again:: notified about that, and the user is asked again::
@app.route('/login', methods=['GET', 'POST']) @app.route('/login', methods=['GET', 'POST'])
def login(): def login():
@ -73,12 +73,12 @@ notified about that and the user asked again::
return redirect(url_for('show_entries')) return redirect(url_for('show_entries'))
return render_template('login.html', error=error) return render_template('login.html', error=error)
The logout function on the other hand removes that key from the session The logout function, on the other hand, removes that key from the session
again. We use a neat trick here: if you use the :meth:`~dict.pop` method again. We use a neat trick here: if you use the :meth:`~dict.pop` method
of the dict and pass a second parameter to it (the default) the method of the dict and pass a second parameter to it (the default), the method
will delete the key from the dictionary if present or do nothing when that will delete the key from the dictionary if present or do nothing when that
key was not in there. This is helpful because we don't have to check in key is not in there. This is helpful because now we don't have to check
that case if the user was logged in. if the user was logged in.
:: ::