Skip to content

Commit

Permalink
Typo's and fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
Martijn Jacobs committed Dec 28, 2015
1 parent 6c3afb0 commit fed77c6
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 6 deletions.
4 changes: 2 additions & 2 deletions docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ See `Travis`_ for the current tested platforms.

Installation
------------
Please see the installation instructions of `Oscar`_ to install Django Oscar and how to create your own project. Then you can install Django Oscar API by simply typing:
Please see the installation instructions of `Oscar`_ to install Oscar and how to create your own project. Then you can install Oscar API by simply typing:

.. _`Oscar`: http://django-oscar.readthedocs.org/en/releases-1.1/internals/getting_started.html

Expand All @@ -42,7 +42,7 @@ Or you could add ``django-oscar-api`` to your project dependencies.

.. caution::

As Django Oscar API is not released on pypi (yet), use:
As Oscar API is not released on pypi (yet), use:

.. code-block:: bash
Expand Down
8 changes: 4 additions & 4 deletions docs/source/usage/customizing_oscarapi.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,17 +2,17 @@
Customizing Oscar API
============================

By using the `django-rest-framework`_ life has become easy, at least for customizing the Oscar API. Django Oscar API exists of a collection of views and serializers which can be overriden by following the steps below.
By using the `django-rest-framework`_ life has become easy, at least for customizing the Oscar API. Oscar API exists of a collection of views and serializers which can be overriden by following the steps below.

.. note::
In oscar you can `fork an app`_ to easily customize only the things you want to change.

.. _`fork an app`: http://django-oscar.readthedocs.org/en/releases-1.1/topics/fork_app.html
.. _`django-rest-framework`: http://www.django-rest-framework.org

Django Oscar API is using the basics of this so you can see Django Oscar API as one of the apps you customized just like in Oscar. Each Oscar app (or forked app) has a ``app.py`` which manages the url's to your custom views.
Oscar API is using the basics of this so you can see Oscar API as one of the apps you customized just like in Oscar. Each Oscar app (or forked app) has a ``app.py`` which manages the url's to your custom views.

In Django Oscar API the entry point of this is ``oscarapi.app:RESTApiApplication``.
In Oscar API the entry point of this is ``oscarapi.app:RESTApiApplication``.

In your own app, you can extend this class, and override some of the urls to
direct them to your own views. You can subclass any of the views in oscarapi,
Expand All @@ -39,7 +39,7 @@ So, to modify some of the functionality in oscarapi, do the following:


3. Include your own app in INSTALLED_APPS instead of ``django-oscar-api``. (and add ``django-oscar-api`` to your app's dependencies) and see if this works.
4. Add a view which you want to change from Django Oscar API in your ``mycustomapi`` app and add this to your app's ``urls.py``.
4. Add a view which you want to change from Oscar API in your ``mycustomapi`` app and add this to your app's ``urls.py``.

.. attention::
Add example please.
Expand Down

0 comments on commit fed77c6

Please sign in to comment.