Skip to content

Commit db2a49c

Browse files
Docs: typos & minor fixes in 'quickstart'.
1 parent 23a2244 commit db2a49c

File tree

1 file changed

+6
-7
lines changed

1 file changed

+6
-7
lines changed

docs/quickstart.rst

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,9 @@ Quickstart
55

66
.. currentmodule:: flask.ext.restful
77

8-
It1s time to write your first REST API. This guide assumes you have `Flask
9-
<http://flask.pocoo.org>`_ and Flask-RESTful installed and a working
10-
understanding of Flask. If not, follow the steps in the Installation section,
11-
or read through the Flask Quickstart.
8+
It's time to write your first REST API. This guide assumes you have a working understanding of `Flask
9+
<http://flask.pocoo.org>`_, and that you have already installed both Flask and Flask-RESTful.
10+
If not, then follow the steps in the installation_ section.
1211

1312

1413

@@ -173,9 +172,9 @@ functions such as :py:meth:`types.date` and :py:meth:`types.url`.
173172
Data Formatting
174173
---------------
175174

176-
By default, all fields in your return iterable will be rendered as is. While
175+
By default, all fields in your return iterable will be rendered as-is. While
177176
this works great when you're just dealing with Python data structures,
178-
it can become very frustrating when working with objects. To solve with
177+
it can become very frustrating when working with objects. To solve this
179178
problem, Flask-RESTful provides the :py:class:`fields` module and the
180179
:py:meth:`marshal_with` decorator. Similar to the Django ORM and WTForm, you
181180
use the fields module to describe the structure of your response. ::
@@ -205,7 +204,7 @@ The above example takes a python object and prepares it to be serialized. The
205204
:py:meth:`marshal_with` decorator will apply the transformation described by
206205
``resource_fields``. The only field extracted from the object is ``task``. The
207206
:py:class:`fields.Url` field is a special field that takes an endpoint name
208-
and generates a Url for that endpoint in the response. Many of the field types
207+
and generates a URL for that endpoint in the response. Many of the field types
209208
you need are already included. See the :py:class:`fields` guide for a complete
210209
list.
211210

0 commit comments

Comments
 (0)