Commit Graph

29 Commits

Author SHA1 Message Date
Kyle
e40ffd60d4 Issue #1707 - Add documentation about the caching of GenericAPIView.queryset
to the `queryset` property, `get_queryset()`, and do generic-views.md; remove
changes to the viewsets.md documentation from my last commit.
2014-07-28 10:11:40 -07:00
Kyle Valade
48b02f016a Issue #1707: Add documentation to api-docs.viewsets notifying users
that they should use the get_queryset() method when overriding a
ModelViewSet method, such as list(). Otherwise, since queryset is
a static property, the value will be cached for every instance of
that ViewSet.
2014-07-27 14:01:43 -07:00
Charlie Denton
40b148a2e4 Viewsets docs typo
The docstring in the example said "update" instead of "create".
2014-02-03 14:54:44 +00:00
Tom Christie
3c3906e278 Clarify wording, fixes #1133. 2013-12-04 08:51:34 +00:00
Diego Ponciano
2a6a2013df small typo correction on ViewSet example code 2013-09-11 17:25:57 -03:00
Kristian Øllegaard
afee470aca More information on how actions are mapped to URLs in viewsets 2013-08-26 11:02:01 +02:00
Tom Christie
5e40e50f2b Include import paths throughout docs.
Closes #1051.  Thanks to @pydanny for the report.
2013-08-21 19:46:09 +01:00
Eric Buehl
b676cce61f pedantic doc updates 2013-07-18 19:03:38 -07:00
Tom Christie
3eaad89c16 Docs fix 2013-07-15 21:23:34 +01:00
Yuri Prezument
77dd334026 Fix Mixin class name in viewsets docs example 2013-07-14 19:16:56 +03:00
Tom Christie
8d83ff8e6c Add decorator brackets back. Refs #941 2013-06-21 23:12:16 +01:00
Tom Christie
a68f473dd8 Brackets not required on decorator without arguments 2013-06-21 23:25:14 +02:00
Philip Douglas
f3529f1f4a Correct docs' incorrect usage of action decorator
If you don't call it, it doesn't work.
2013-06-21 16:26:28 +01:00
Ryan Kaskel
e483c4fed6 Remove pass statement before docstring. 2013-06-07 10:07:42 +01:00
Tom Christie
27d8b848bc Add notes on 'method' argument to '@action' decorator 2013-06-02 20:40:56 +01:00
Pascal Borreli
8f35ac4f93 Fixed typos 2013-05-28 15:09:23 +01:00
Sebastien Beal
b0201bcfbf Fix doc typo in UserViewSet example 2013-05-26 11:52:45 +09:00
Johannes
df11198c6c Fix typo + grammar in viewsets docs 2013-05-17 12:27:48 +02:00
Tom Christie
31f94ab409 Added GenericViewSet and docs tweaking 2013-05-09 13:31:42 +01:00
Tom Christie
74beaefd12 Simplifying bits of docs 2013-05-02 12:08:05 +01:00
Tom Christie
8fa79a7fd3 Deal with List/Instance suffixes for viewsets 2013-04-26 14:59:21 +01:00
Tom Christie
50c6bc5762 Fix up viewset docs slightly 2013-04-26 13:31:19 +01:00
Tom Christie
51f80c3604 Fix broken queryset in example 2013-04-26 10:23:05 +01:00
Tom Christie
74b3307978 Docs, docs, docs 2013-04-25 20:43:37 +01:00
Tom Christie
9abaf77401 More viewset/router docs 2013-04-25 17:39:33 +01:00
Tom Christie
95abe6e844 Cleanup docstrings 2013-04-25 12:47:34 +01:00
Tom Christie
b94da2468c Various clean up and lots of docs 2013-04-24 22:40:24 +01:00
Tom Christie
d75cebf756 Remove router bit from viewset docs 2013-04-11 15:48:41 +01:00
Tom Christie
027792c981 Viewsets and routers in seperate docs 2013-04-09 11:54:51 +01:00