show 'run --debug' in docs

Reverts commit 4d69165ab6. Now that a
release has this option, it's ok to show it in the docs. It had been
reverted because the 2.2.x docs showed it before 2.2.3 was released.
This commit is contained in:
David Lord 2023-02-15 14:24:56 -08:00
parent b945f988f9
commit 24df8fc89d
No known key found for this signature in database
GPG key ID: 7A1C87E3F5BC42A8
8 changed files with 23 additions and 15 deletions

View file

@ -95,7 +95,7 @@ the ``--debug`` option.
.. code-block:: console
$ flask --app hello --debug run
$ flask --app hello run --debug
* Serving Flask app "hello"
* Debug mode: on
* Running on http://127.0.0.1:5000/ (Press CTRL+C to quit)
@ -103,6 +103,14 @@ the ``--debug`` option.
* Debugger is active!
* Debugger PIN: 223-456-919
The ``--debug`` option can also be passed to the top level ``flask`` command to enable
debug mode for any command. The following two ``run`` calls are equivalent.
.. code-block:: console
$ flask --app hello --debug run
$ flask --app hello run --debug
Watch and Ignore Files with the Reloader
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@ -550,7 +558,7 @@ a name such as "flask run".
Click the *Script path* dropdown and change it to *Module name*, then input ``flask``.
The *Parameters* field is set to the CLI command to execute along with any arguments.
This example uses ``--app hello --debug run``, which will run the development server in
This example uses ``--app hello run --debug``, which will run the development server in
debug mode. ``--app hello`` should be the import or file with your Flask app.
If you installed your project as a package in your virtualenv, you may uncheck the

View file

@ -47,17 +47,17 @@ Debug Mode
The :data:`DEBUG` config value is special because it may behave inconsistently if
changed after the app has begun setting up. In order to set debug mode reliably, use the
``--debug`` option on the ``flask`` command. ``flask run`` will use the interactive
debugger and reloader by default in debug mode.
``--debug`` option on the ``flask`` or ``flask run`` command. ``flask run`` will use the
interactive debugger and reloader by default in debug mode.
.. code-block:: text
$ flask --app hello --debug run
$ flask --app hello run --debug
Using the option is recommended. While it is possible to set :data:`DEBUG` in your
config or code, this is strongly discouraged. It can't be read early by the ``flask run``
command, and some systems or extensions may have already configured themselves based on
a previous value.
config or code, this is strongly discouraged. It can't be read early by the
``flask run`` command, and some systems or extensions may have already configured
themselves based on a previous value.
Builtin Configuration Values

View file

@ -43,7 +43,7 @@ The debugger is enabled by default when the development server is run in debug m
.. code-block:: text
$ flask --app hello --debug run
$ flask --app hello run --debug
When running from Python code, passing ``debug=True`` enables debug mode, which is
mostly equivalent.
@ -72,7 +72,7 @@ which can interfere.
.. code-block:: text
$ flask --app hello --debug run --no-debugger --no-reload
$ flask --app hello run --debug --no-debugger --no-reload
When running from Python:

View file

@ -108,7 +108,7 @@ To enable debug mode, use the ``--debug`` option.
.. code-block:: text
$ flask --app hello --debug run
$ flask --app hello run --debug
* Serving Flask app 'hello'
* Debug mode: on
* Running on http://127.0.0.1:5000 (Press CTRL+C to quit)

View file

@ -24,7 +24,7 @@ debug mode.
.. code-block:: text
$ flask --app hello --debug run
$ flask --app hello run --debug
This enables debug mode, including the interactive debugger and reloader, and then
starts the server on http://localhost:5000/. Use ``flask run --help`` to see the

View file

@ -137,7 +137,7 @@ follow the tutorial.
.. code-block:: text
$ flask --app flaskr --debug run
$ flask --app flaskr run --debug
You'll see output similar to this: