📝 Update Uvicorn docs with new --reload option (#74)

docs/contributing.md

@@ -106,7 +106,7 @@ That way, you can edit the documentation/source files and see the changes live.
 And if you run the examples with, e.g.:
 
 ```bash
-uvicorn tutorial001:app --debug
+uvicorn tutorial001:app --reload
 ```
 
 as Uvicorn by default will use the port `8000`, the documentation on port `8008` won't clash.

docs/deployment.md

@@ -239,7 +239,7 @@ You can deploy **FastAPI** directly without Docker too.
 
 You just need to install <a href="https://www.uvicorn.org/" target="_blank">Uvicorn</a> (or any other ASGI server).
 
-And run your application the same way you have done in the tutorials, but without the `--debug` option, e.g.:
+And run your application the same way you have done in the tutorials, but without the `--reload` option, e.g.:
 
 ```bash
 uvicorn main:app --host 0.0.0.0 --port 80

docs/index.md

@@ -116,17 +116,17 @@ If you don't know, check the _"In a hurry?"_ section about <a href="https://fast
 Run the server with:
 
 ```bash
-uvicorn main:app --debug
+uvicorn main:app --reload
 ```
 
 <details markdown="1">
-<summary>About the command <code>uvicorn main:app --debug</code>...</summary>
+<summary>About the command <code>uvicorn main:app --reload</code>...</summary>
 
 The command `uvicorn main:app` refers to:
 
 * `main`: the file `main.py` (the Python "module").
 * `app`: the object created inside of `main.py` with the line `app = FastAPI()`.
-* `--debug`: make the server restart after code changes. Only do this for development.
+* `--reload`: make the server restart after code changes. Only do this for development.
 
 </details>
 
@@ -199,7 +199,7 @@ def create_item(item_id: int, item: Item):
     return {"item_name": item.name, "item_id": item_id}
 ```
 
-The server should reload automatically (because you added `--debug` to the `uvicorn` command above).
+The server should reload automatically (because you added `--reload` to the `uvicorn` command above).
 
 ### Interactive API docs upgrade
 

docs/tutorial/bigger-applications.md

@@ -274,7 +274,7 @@ The end result is that the item paths are now:
 Now, run `uvicorn`, using the module `app.main` and the variable `app`:
 
 ```bash
-uvicorn app.main:app --debug
+uvicorn app.main:app --reload
 ```
 
 And open the docs at <a href="http://127.0.0.1:8000/docs" target="_blank">http://127.0.0.1:8000/docs</a>.

docs/tutorial/first-steps.md

@@ -9,7 +9,7 @@ Copy that to a file `main.py`.
 Run the live server:
 
 ```bash
-uvicorn main:app --debug
+uvicorn main:app --reload
 ```
 
 !!! note
@@ -17,7 +17,7 @@ uvicorn main:app --debug
 
     * `main`: the file `main.py` (the Python "module").
     * `app`: the object created inside of `main.py` with the line `app = FastAPI()`.
-    * `--debug`: make the server restart after code changes. Only use for development.
+    * `--reload`: make the server restart after code changes. Only use for development.
 
 You will see an output like:
 
@@ -146,7 +146,7 @@ This will be the main point of interaction to create all your API.
 This `app` is the same one referred by `uvicorn` in the command:
 
 ```bash
-uvicorn main:app --debug
+uvicorn main:app --reload
 ```
 
 If you create your app like:
@@ -158,7 +158,7 @@ If you create your app like:
 And put it in a file `main.py`, then you would call `uvicorn` like:
 
 ```bash
-uvicorn main:my_awesome_api --debug
+uvicorn main:my_awesome_api --reload
 ```
 
 ### Step 3: create a path operation
@@ -311,4 +311,4 @@ There are many other objects and models that will be automatically converted to
 * Create an `app` instance.
 * Write a **path operation decorator** (like `@app.get("/")`).
 * Write a **path operation function** (like `def root(): ...` above).
-* Run the debugging server (like `uvicorn main:app --debug`).
+* Run the development server (like `uvicorn main:app --reload`).

docs/tutorial/intro.md

@@ -13,7 +13,7 @@ All the code blocks can be copied and used directly (they are actually tested Py
 To run any of the examples, copy the code to a file `main.py`, and start `uvicorn` with:
 
 ```bash
-uvicorn main:app --debug
+uvicorn main:app --reload
 ```
 
 It is **HIGHLY encouraged** that you write or copy the code, edit it and run it locally.

docs/tutorial/security/first-steps.md

@@ -27,7 +27,7 @@ Copy the example in a file `main.py`:
 Run the example with:
 
 ```bash
-uvicorn main:app --debug
+uvicorn main:app --reload
 ```
 
 ## Check it

docs/tutorial/sql-databases.md

@@ -270,7 +270,7 @@ You can copy it, let's say, to a file `main.py`.
 Then you can run it with Uvicorn:
 
 ```bash
-uvicorn main:app --debug
+uvicorn main:app --reload
 ```
 
 And then, you can open your browser at <a href="http://127.0.0.1:8000/docs" target="_blank">http://127.0.0.1:8000/docs</a>.

docs/tutorial/sub-applications-proxy.md

@@ -75,7 +75,7 @@ Here you need to make sure you use the same path that you used for the `openapi_
 Now, run `uvicorn`, if your file is at `main.py`, it would be:
 
 ```bash
-uvicorn main:app --debug
+uvicorn main:app --reload
 ```
 
 And open the docs at <a href="http://127.0.0.1:8000/docs" target="_blank">http://127.0.0.1:8000/docs</a>.

docs/tutorial/websockets.md

@@ -69,7 +69,7 @@ To learn more about the options, check Starlette's documentation for:
 If your file is named `main.py`, run your application with:
 
 ```bash
-uvicorn main:app --debug
+uvicorn main:app --reload
 ```
 
 Open your browser at <a href="http://127.0.0.1:8000" target="_blank">http://127.0.0.1:8000</a>.