Skip to content

Commit 77086bf

Browse files
committed
Prefer flask run --debug in docs
1 parent 47c7f72 commit 77086bf

File tree

8 files changed

+11
-11
lines changed

8 files changed

+11
-11
lines changed
21.7 KB
Loading

docs/cli.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -95,7 +95,7 @@ the ``--debug`` option.
9595

9696
.. code-block:: console
9797
98-
$ flask --app hello --debug run
98+
$ flask --app hello run --debug
9999
* Serving Flask app "hello"
100100
* Debug mode: on
101101
* Running on http://127.0.0.1:5000/ (Press CTRL+C to quit)
@@ -550,7 +550,7 @@ a name such as "flask run".
550550
Click the *Script path* dropdown and change it to *Module name*, then input ``flask``.
551551

552552
The *Parameters* field is set to the CLI command to execute along with any arguments.
553-
This example uses ``--app hello --debug run``, which will run the development server in
553+
This example uses ``--app hello run --debug``, which will run the development server in
554554
debug mode. ``--app hello`` should be the import or file with your Flask app.
555555

556556
If you installed your project as a package in your virtualenv, you may uncheck the

docs/config.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -47,15 +47,15 @@ Debug Mode
4747

4848
The :data:`DEBUG` config value is special because it may behave inconsistently if
4949
changed after the app has begun setting up. In order to set debug mode reliably, use the
50-
``--debug`` option on the ``flask`` command.``flask run`` will use the interactive
50+
``--debug`` option on the ``flask run`` command. ``flask run`` will use the interactive
5151
debugger and reloader by default in debug mode.
5252

5353
.. code-block:: text
5454
55-
$ flask --app hello --debug run
55+
$ flask --app hello run --debug
5656
5757
Using the option is recommended. While it is possible to set :data:`DEBUG` in your
58-
config or code, this is strongly discouraged. It can't be read early by the ``flask``
58+
config or code, this is strongly discouraged. It can't be read early by the ``flask run``
5959
command, and some systems or extensions may have already configured themselves based on
6060
a previous value.
6161

docs/debugging.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ The debugger is enabled by default when the development server is run in debug m
4343

4444
.. code-block:: text
4545
46-
$ flask --app hello --debug run
46+
$ flask --app hello run --debug
4747
4848
When running from Python code, passing ``debug=True`` enables debug mode, which is
4949
mostly equivalent.
@@ -72,7 +72,7 @@ which can interfere.
7272

7373
.. code-block:: text
7474
75-
$ flask --app hello --debug run --no-debugger --no-reload
75+
$ flask --app hello run --debug --no-debugger --no-reload
7676
7777
When running from Python:
7878

docs/quickstart.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -108,7 +108,7 @@ To enable debug mode, use the ``--debug`` option.
108108

109109
.. code-block:: text
110110
111-
$ flask --app hello --debug run
111+
$ flask --app hello run --debug
112112
* Serving Flask app 'hello'
113113
* Debug mode: on
114114
* Running on http://127.0.0.1:5000 (Press CTRL+C to quit)

docs/server.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ debug mode.
2424

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

docs/tutorial/factory.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -137,7 +137,7 @@ follow the tutorial.
137137

138138
.. code-block:: text
139139
140-
$ flask --app flaskr --debug run
140+
$ flask --app flaskr run --debug
141141
142142
You'll see output similar to this:
143143

examples/tutorial/README.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ Run
4848
.. code-block:: text
4949
5050
$ flask --app flaskr init-db
51-
$ flask --app flaskr --debug run
51+
$ flask --app flaskr run --debug
5252
5353
Open http://127.0.0.1:5000 in a browser.
5454

0 commit comments

Comments
 (0)