Conventions

In this book, you will find a number of text styles that distinguish between different kinds of information. Here are some examples of these styles and an explanation of their meaning.

Code words in text, database table names, folder names, filenames, file extensions, pathnames, dummy URLs, user input, and Twitter handles are shown as follows: "We can include other contexts through the use of the include directive."

A block of code is set as follows:

from app import api
from models import Comment

api.create_api(Comment, methods=['GET', 'POST'])

When we wish to draw your attention to a particular part of a code block, the relevant lines or items are set in bold:

{% block content %}
  {{ entry.body }}

  <h4 id="comment-form">Submit a comment</h4>
  {% include "entries/includes/comment_form.html" %}
{% endblock %}

Any command-line input or output is written as follows:

(blog) $ python manage.py db upgrade
INFO  [alembic.migration] Context impl SQLiteImpl.
INFO  [alembic.migration] Will assume non-transactional DDL.
INFO  [alembic.migration] Running upgrade 594ebac9ef0c -> 490b6bc5f73c, empty message

New terms and important words are shown in bold. Words that you see on the screen, for example, in menus or dialog boxes, appear in the text like this: "You should see the message Hello, Flask displayed on a blank white page."

Note

Warnings or important notes appear in a box like this.

Tip

Tips and tricks appear like this.