Skip to content

Commit

Permalink
Add tip for app discovery behavior in quickstart docs
Browse files Browse the repository at this point in the history
  • Loading branch information
greyli authored and davidism committed May 11, 2021
1 parent 3e268f4 commit aa1e48a
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 2 deletions.
4 changes: 2 additions & 2 deletions docs/cli.rst
Original file line number Diff line number Diff line change
Expand Up @@ -50,8 +50,8 @@ application, most use cases should be simple. Here are the typical values:
factory (``create_app`` or ``make_app``).

``FLASK_APP=hello``
The given name is imported, automatically detecting an app (``app`` or
``application``) or factory (``create_app`` or ``make_app``).
The given name is imported, automatically detecting an app (``app``
or ``application``) or factory (``create_app`` or ``make_app``).

----

Expand Down
6 changes: 6 additions & 0 deletions docs/quickstart.rst
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,12 @@ to tell your terminal the application to work with by exporting the
> flask run
* Running on http://127.0.0.1:5000/
.. admonition:: Application Discovery Behavior

As a shortcut, if the file is named ``app.py`` or ``wsgi.py``, you
don't have to set the ``FLASK_APP`` environment variable. See
:doc:`/cli` for more details.

This launches a very simple builtin server, which is good enough for
testing but probably not what you want to use in production. For
deployment options see :doc:`deploying/index`.
Expand Down

0 comments on commit aa1e48a

Please sign in to comment.