Skip to content

Commit

Permalink
Fixing typos in routers.md
Browse files Browse the repository at this point in the history
  • Loading branch information
James Summerfield committed Aug 3, 2013
1 parent e4144b5 commit 4ff1dc6
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions docs/api-guide/routers.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ The example above would generate the following URL patterns:
### Extra link and actions

Any methods on the viewset decorated with `@link` or `@action` will also be routed.
For example, a given method like this on the `UserViewSet` class:
For example, given a method like this on the `UserViewSet` class:

@action(permission_classes=[IsAdminOrIsSelf])
def set_password(self, request, pk=None):
Expand Down Expand Up @@ -66,7 +66,7 @@ This router includes routes for the standard set of `list`, `create`, `retrieve`
<tr><td>POST</td><td>@action decorated method</td></tr>
</table>

By default the URLs created by `SimpleRouter` are appending with a trailing slash.
By default the URLs created by `SimpleRouter` are appended with a trailing slash.
This behavior can be modified by setting the `trailing_slash` argument to `False` when instantiating the router. For example:

router = SimpleRouter(trailing_slash=False)
Expand All @@ -90,7 +90,7 @@ This router is similar to `SimpleRouter` as above, but additionally includes a d
<tr><td>POST</td><td>@action decorated method</td></tr>
</table>

As with `SimpleRouter` the trailing slashs on the URL routes can be removed by setting the `trailing_slash` argument to `False` when instantiating the router.
As with `SimpleRouter` the trailing slashes on the URL routes can be removed by setting the `trailing_slash` argument to `False` when instantiating the router.

router = DefaultRouter(trailing_slash=False)

Expand Down Expand Up @@ -139,7 +139,7 @@ The `SimpleRouter` class provides another example of setting the `.routes` attri

## Advanced custom routers

If you want to provide totally custom behavior, you can override `BaseRouter` and override the `get_urls(self)` method. The method should insect the registered viewsets and return a list of URL patterns. The registered prefix, viewset and basename tuples may be inspected by accessing the `self.registry` attribute.
If you want to provide totally custom behavior, you can override `BaseRouter` and override the `get_urls(self)` method. The method should inspect the registered viewsets and return a list of URL patterns. The registered prefix, viewset and basename tuples may be inspected by accessing the `self.registry` attribute.

You may also want to override the `get_default_base_name(self, viewset)` method, or else always explicitly set the `base_name` argument when registering your viewsets with the router.

Expand Down

0 comments on commit 4ff1dc6

Please sign in to comment.