Browse Source

Move docs explaining instantiating Flask

pull/683/head
Alex Couper 12 years ago
parent
commit
cc8a85d753
  1. 17
      docs/quickstart.rst

17
docs/quickstart.rst

@ -38,15 +38,14 @@ should see your hello world greeting.
So what did that code do? So what did that code do?
1. First we imported the :class:`~flask.Flask` class. An instance of this 1. First we imported the :class:`~flask.Flask` class. An instance of this
class will be our WSGI application. The first argument is the name of class will be our WSGI application.
the application's module. If you are using a single module (as in this 2. Next we create an instance of this class. The first argument is the name of
example), you should use `__name__` because depending on if it's started as the application's module or package. If you are using a single module (as
application or imported as module the name will be different (``'__main__'`` in this example), you should use `__name__` because depending on if it's
versus the actual import name). For more information, have a look at the started as application or imported as module the name will be different
:class:`~flask.Flask` documentation. (``'__main__'`` versus the actual import name). For more information, have
2. Next we create an instance of this class. We pass it the name of the module a look at the :class:`~flask.Flask` documentation. This is needed so that
or package. This is needed so that Flask knows where to look for templates, Flask knows where to look for templates, static files, and so on.
static files, and so on.
3. We then use the :meth:`~flask.Flask.route` decorator to tell Flask what URL 3. We then use the :meth:`~flask.Flask.route` decorator to tell Flask what URL
should trigger our function. should trigger our function.
4. The function is given a name which is also used to generate URLs for that 4. The function is given a name which is also used to generate URLs for that

Loading…
Cancel
Save