Skip to content

Commit

Permalink
📝 Add note about how subcommands with function names using underscore…
Browse files Browse the repository at this point in the history
…s are converted to dashes (#403)

Co-authored-by: Sebastián Ramírez <[email protected]>
  • Loading branch information
targhs and tiangolo authored Nov 5, 2022
1 parent 4b930b2 commit 7c88b2d
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions docs/tutorial/commands/name.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,3 +44,13 @@ Creating user: Camila
```

</div>

Note that any underscores in the function name will be replaced with dashes.

So if your function is something like:

```Python
def create_user(username: str):
...
```
Then the command name will be `create-user`.

0 comments on commit 7c88b2d

Please sign in to comment.