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

Remove -a/--app from Quickstart documentation (#2046)

Browse source 
* Remove `-a/--app` from Quickstart documentation

As mentioned in #2009, simplifying the CLI saw the removal of the `-a/--app` flag. Therefore, the only way to specify the module to import is by setting `FLASK_APP`.

* Remove misleading `either` from CLI help

The CLI help details how to run the application, but still uses the phrasing "either through the `FLASK_APP`...". This likely is an artifact from when `-a/--app` was still present in the CLI.
This commit is contained in:
Michael Recachinas 2016-10-01 12:45:22 -04:00 • committed by Markus Unterwaditzer
parent 7186a5aaf5
commit 49ecc88d99
2 changed files with 5 additions and 5 deletions
Download patch file Download diff file Expand all files Collapse all files

8
docs/quickstart.rst
View file

@ -102,10 +102,10 @@ docs to see the alternative method for running a server.
Invalid Import Name
```````````````````
The ``-a`` argument to :command:`flask` is the name of the module to
import. In case that module is incorrectly named you will get an import
error upon start (or if debug is enabled when you navigate to the
application). It will tell you what it tried to import and why it failed.
The ``FLASK_APP`` environment variable is the name of the module to import at
:command:`flask run`. In case that module is incorrectly named you will get an
import error upon start (or if debug is enabled when you navigate to the
application). It will tell you what it tried to import and why it failed.
The most common reason is a typo or because you did not actually create an
``app`` object.

2
flask/cli.py
View file

@ -469,7 +469,7 @@ def shell_command():
cli = FlaskGroup(help="""\
This shell command acts as general utility script for Flask applications.
It loads the application configured (either through the FLASK_APP environment
It loads the application configured (through the FLASK_APP environment
variable) and then provides commands either provided by the application or
Flask itself.