summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorcaljess599 <caljess599@gmail.com>2014-10-28 17:00:08 (GMT)
committercaljess599 <caljess599@gmail.com>2014-10-28 17:00:08 (GMT)
commit8c0bda34e27a0c6d7f4850fb6eb3de23772c7fde (patch)
treefece2cb0f989acf6f793ba03e36231b02b1ca119
parent7cb1c882b01b1639ae2e8b44e788ba5fc307d668 (diff)
downloaddjango-import-export-8c0bda34e27a0c6d7f4850fb6eb3de23772c7fde.zip
django-import-export-8c0bda34e27a0c6d7f4850fb6eb3de23772c7fde.tar.gz
django-import-export-8c0bda34e27a0c6d7f4850fb6eb3de23772c7fde.tar.bz2
Update getting_started.rst
Adding for the sake of all total beginners like myself that the resources classes are defined in admin.py. Yes this is totally obvious for people who know what they're doing but it wasn't for me. Also a few language corrections.
-rw-r--r--docs/getting_started.rst10
1 files changed, 5 insertions, 5 deletions
diff --git a/docs/getting_started.rst b/docs/getting_started.rst
index 90dfbd5..0402aee 100644
--- a/docs/getting_started.rst
+++ b/docs/getting_started.rst
@@ -2,7 +2,7 @@
Getting started
===============
-For example purposes, we'll be use simplified book app, here is our
+For example purposes, we'll use a simplified book app. Here is our
``core.models.py``::
class Author(models.Model):
@@ -39,7 +39,7 @@ Creating import-export resource
-------------------------------
To integrate `django-import-export` with ``Book`` model, we will create
-a resource class that will describe how this resource can be imported or
+a resource class in ``admin.py`` that will describe how this resource can be imported or
exported.
::
@@ -102,7 +102,7 @@ model relationships::
Declaring fields
----------------
-It is possible to override a resource field to change some of it's
+It is possible to override a resource field to change some of its
options::
from import_export import fields
@@ -113,7 +113,7 @@ options::
class Meta:
model = Book
-Other fields that are not existing in the target model may be added::
+Other fields that don't exist in the target model may be added::
from import_export import fields
@@ -226,7 +226,7 @@ that have column ``delete`` set to ``1``.
Admin integration
-----------------
-Admin integration is achived by subclassing
+Admin integration is achived by subclassing (in ``admin.py``)
``ImportExportModelAdmin`` or one of the available mixins (``ImportMixin``,
``ExportMixin``, or ``ImportExportMixin``)::