Skip to content

Commit

Permalink
show 'run --debug' in docs
Browse files Browse the repository at this point in the history
Reverts commit 4d69165. 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.
  • Loading branch information
davidism committed Feb 15, 2023
1 parent b945f98 commit 24df8fc
Show file tree
Hide file tree
Showing 8 changed files with 23 additions and 15 deletions.
12 changes: 10 additions & 2 deletions docs/cli.rst
Original file line number Diff line number Diff line change
Expand Up @@ -95,14 +95,22 @@ 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)
* Restarting with inotify reloader
* 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
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Expand Down Expand Up @@ -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
Expand Down
12 changes: 6 additions & 6 deletions docs/config.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 2 additions & 2 deletions docs/debugging.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down Expand Up @@ -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:

Expand Down
2 changes: 1 addition & 1 deletion docs/quickstart.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down
2 changes: 1 addition & 1 deletion docs/server.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/tutorial/factory.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand Down
2 changes: 1 addition & 1 deletion examples/celery/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ In a separate terminal, activate the virtualenv and run the Flask development se

```shell
$ . ./.venv/bin/activate
$ flask -A task_app --debug run
$ flask -A task_app run --debug
```

Go to http://localhost:5000/ and use the forms to submit tasks. You can see the polling
Expand Down
2 changes: 1 addition & 1 deletion examples/tutorial/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ Run
.. code-block:: text
$ flask --app flaskr init-db
$ flask --app flaskr --debug run
$ flask --app flaskr run --debug
Open http://127.0.0.1:5000 in a browser.

Expand Down

0 comments on commit 24df8fc

Please sign in to comment.