maya-chen/flask
1
0
Fork 0
forked from orbit-oss/flask
Code Pull requests Activity

show 'run --debug' in docs

Browse source 
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
Download patch file Download diff file Expand all files Collapse all files

12
docs/config.rst
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