Edit settings --uds argument description for clarity (#1218)

* Edit settings --uds argument description for clarity * include PR suggestion in docs/settings.md Co-authored-by: Marcelo Trylesinski <[email protected]> Co-authored-by: Marcelo Trylesinski <[email protected]>
encode · Oct 15, 2021 · 48edc94 · 48edc94
1 parent fe16ac1
commit 48edc94
Showing 1 changed file with 1 addition and 1 deletion.
diff --git a/docs/settings.md b/docs/settings.md
@@ -16,7 +16,7 @@ you should put `uvicorn.run` into `if __name__ == '__main__'` clause in the main
 
 * `--host <str>` - Bind socket to this host. Use `--host 0.0.0.0` to make the application available on your local network. IPv6 addresses are supported, for example: `--host '::'`. **Default:** *'127.0.0.1'*.
 * `--port <int>` - Bind to a socket with this port. **Default:** *8000*.
-* `--uds <str>` - Bind to a UNIX domain socket. Useful if you want to run Uvicorn behind a reverse proxy.
+* `--uds <path>` - Bind to a UNIX domain socket, for example `--uds /tmp/uvicorn.sock`. Useful if you want to run Uvicorn behind a reverse proxy.
 * `--fd <int>` - Bind to socket from this file descriptor. Useful if you want to run Uvicorn within a process manager.
 
 ## Development