tiangolo / fastapi

FastAPI framework, high performance, easy to learn, fast to code, ready for production
https://fastapi.tiangolo.com/
MIT License
73.21k stars 6.17k forks source link

Remove Extra Line Item from Install Command and Separate Run Command from Output for Easier Copying of These Commands #11645

Closed pollyandhiscat closed 1 month ago

pollyandhiscat commented 1 month ago

The README contains extra text in some of the commands users can copy, but this text is not part of a valid command.

Example:

This....

image

becomes this....

image

The bottom line in the current version will cause the command to fail, like so:

image

The other change is similar in nature, but directed towards the command to run the example app. The output text displayed in the command line is not part of the command and shouldn't be copied by the user to run their app:

This.... image

becomes this...

image

The command portion has been separated so that a user can copy it without the extra output text (which is still present but in its own section).

P.S. Could an argument may be made to omit the '$' in these commands and simply have the command itself? Then a user could straight up just copy and paste the command. Not sure if this is desired formatting wise though. Let me know! :)