Conventions used
There are a number of text conventions used throughout this book.
Code in text
: Indicates code words in text, database table names, folder names, filenames, file extensions, pathnames, dummy URLs, user input, and Twitter handles. Here is an example: “To switch back to the original main
branch, we run git checkout main
.”
A block of code is set as follows:
from fastapi import FastAPI from routes.user import user_router import uvicorn
When we wish to draw your attention to a particular part of a code block, the relevant lines or items are set in bold:
from pydantic import BaseModel from typing import List class Event(BaseModel): id: int title: str image: str description: str tags: List[str] location: str
Any command-line input or output is written as follows:
$ git add hello.txt $ git commit -m "Initial commit"
Bold: Indicates a new term, an important word, or words that you see onscreen. For instance, words in menus or dialog boxes appear in bold. Here is an example: “As shown in the previous model diagram, each user will have an Events field, which is a list of the events they have ownership of.”
Tips or Important Notes
Appear like this.