Skip to content

Clarify recommended debug workflow in Quickstart documentation #145161

@adenbad

Description

@adenbad

Documentation

While reviewing the Quickstart documentation, I noticed that debug mode is discussed but the distinction between using app.run(debug=True) and the recommended flask run --debug CLI flag is not clearly emphasized.

The Quickstart explains how to enable debug mode, but it does not clearly distinguish:

  • When app.run(debug=True) should be used
  • That flask run --debug is the modern recommended development workflow
  • Why separating debug configuration from application code is considered best practice

Because many external tutorials still reference app.run(debug=True), new users may be uncertain about which approach is preferred in current Flask versions.

I suggest adding a brief clarification in the Quickstart section noting that flask run --debug is the recommended development workflow, along with a short explanation of the distinction between the two approaches.

Metadata

Metadata

Assignees

No one assigned

    Labels

    docsDocumentation in the Doc dirpendingThe issue will be closed if no feedback is provided

    Projects

    Status

    Todo

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions