From 5967f15f7f5c87987ab60e4b7dc682b06f3ab511 Mon Sep 17 00:00:00 2001
From: Stephan Groß
Date: Wed, 14 Nov 2012 16:11:35 +0100
Subject: updated docs

---
 docs/api-guide/generic-views.md | 4 ++++
 1 file changed, 4 insertions(+)

(limited to 'docs/api-guide')

diff --git a/docs/api-guide/generic-views.md b/docs/api-guide/generic-views.md
index 360ef1a2..9e5119cb 100644
--- a/docs/api-guide/generic-views.md
+++ b/docs/api-guide/generic-views.md
@@ -147,6 +147,10 @@ Provides a `.list(request, *args, **kwargs)` method, that implements listing a q
 
 Should be mixed in with [MultipleObjectAPIView].
 
+**Arguments**:
+
+* `page_size` - Hook to adjust page_size per request.
+
 ## CreateModelMixin
 
 Provides a `.create(request, *args, **kwargs)` method, that implements creating and saving a new model instance.
-- 
cgit v1.2.3


From 38e94bb8b4e04249b18b9b57ef2ddcb7cfc4efa4 Mon Sep 17 00:00:00 2001
From: Stephan Groß
Date: Thu, 15 Nov 2012 11:15:05 +0100
Subject: added global and per resource on/off switch + updated docs

---
 docs/api-guide/generic-views.md | 3 ++-
 docs/api-guide/settings.md      | 6 ++++++
 2 files changed, 8 insertions(+), 1 deletion(-)

(limited to 'docs/api-guide')

diff --git a/docs/api-guide/generic-views.md b/docs/api-guide/generic-views.md
index 9e5119cb..734a91e9 100644
--- a/docs/api-guide/generic-views.md
+++ b/docs/api-guide/generic-views.md
@@ -149,7 +149,8 @@ Should be mixed in with [MultipleObjectAPIView].
 
 **Arguments**:
 
-* `page_size` - Hook to adjust page_size per request.
+* `allow_page_size_param` - Allows you to overwrite the global settings `ALLOW_PAGE_SIZE_PARAM` for a specific view.
+* `page_size_param` - Allows you to customize the page_size parameter. Default is `page_size`.
 
 ## CreateModelMixin
 
diff --git a/docs/api-guide/settings.md b/docs/api-guide/settings.md
index 4f87b30d..2f90369b 100644
--- a/docs/api-guide/settings.md
+++ b/docs/api-guide/settings.md
@@ -150,4 +150,10 @@ Default: `'accept'`
 
 Default: `'format'`
 
+## ALLOW_PAGE_SIZE_PARAM
+
+Allows you to globally pass a page size parameter for an individual request.
+
+Default: `'True'`
+
 [cite]: http://www.python.org/dev/peps/pep-0020/
-- 
cgit v1.2.3


From 3ae203a0184d27318a8a828ce322b151ade0340f Mon Sep 17 00:00:00 2001
From: Stephan Groß
Date: Thu, 15 Nov 2012 12:06:43 +0100
Subject: updated script to just use page_size_kwarg

---
 docs/api-guide/generic-views.md | 3 +--
 docs/api-guide/settings.md      | 8 ++++++--
 2 files changed, 7 insertions(+), 4 deletions(-)

(limited to 'docs/api-guide')

diff --git a/docs/api-guide/generic-views.md b/docs/api-guide/generic-views.md
index 734a91e9..3346c70a 100644
--- a/docs/api-guide/generic-views.md
+++ b/docs/api-guide/generic-views.md
@@ -149,8 +149,7 @@ Should be mixed in with [MultipleObjectAPIView].
 
 **Arguments**:
 
-* `allow_page_size_param` - Allows you to overwrite the global settings `ALLOW_PAGE_SIZE_PARAM` for a specific view.
-* `page_size_param` - Allows you to customize the page_size parameter. Default is `page_size`.
+* `page_size_kwarg` - Allows you to overwrite the global settings `PAGE_SIZE_KWARG` for a specific view.  You can also turn it off for a specific view by setting it to `None`.  Default is `page_size`.
 
 ## CreateModelMixin
 
diff --git a/docs/api-guide/settings.md b/docs/api-guide/settings.md
index 2f90369b..8fce9e4e 100644
--- a/docs/api-guide/settings.md
+++ b/docs/api-guide/settings.md
@@ -150,10 +150,14 @@ Default: `'accept'`
 
 Default: `'format'`
 
-## ALLOW_PAGE_SIZE_PARAM
+## PAGE_SIZE_KWARG
 
 Allows you to globally pass a page size parameter for an individual request.
 
-Default: `'True'`
+The name of the GET parameter of views which inherit ListModelMixin for requesting data with an individual page size.
+
+If the value if this setting is `None` the passing a page size is turned off by default.
+
+Default: `'page_size'`
 
 [cite]: http://www.python.org/dev/peps/pep-0020/
-- 
cgit v1.2.3