aboutsummaryrefslogtreecommitdiffstats
path: root/docs/api-guide/renderers.md
diff options
context:
space:
mode:
authorTom Christie2013-08-25 20:31:04 +0100
committerTom Christie2013-08-25 20:31:04 +0100
commit53d60543c3a5c637491aaeb887269627ce9179ab (patch)
tree740245a9e6c11c25b2416cc3e97fe624089a25ed /docs/api-guide/renderers.md
parentc7847ebc45f38e4d735b77c54ad1a55c87242fac (diff)
downloaddjango-rest-framework-53d60543c3a5c637491aaeb887269627ce9179ab.tar.bz2
Add warning against HTMLFormRenderer
Diffstat (limited to 'docs/api-guide/renderers.md')
-rw-r--r--docs/api-guide/renderers.md2
1 files changed, 2 insertions, 0 deletions
diff --git a/docs/api-guide/renderers.md b/docs/api-guide/renderers.md
index c116ceda..657377d9 100644
--- a/docs/api-guide/renderers.md
+++ b/docs/api-guide/renderers.md
@@ -216,6 +216,8 @@ See also: `TemplateHTMLRenderer`
Renders data returned by a serializer into an HTML form. The output of this renderer does not include the enclosing `<form>` tags or an submit actions, as you'll probably need those to include the desired method and URL. Also note that the `HTMLFormRenderer` does not yet support including field error messages.
+Note that the template used by the `HTMLFormRenderer` class, and the context submitted to it **may be subject to change**. If you need to use this renderer class it is advised that you either make a local copy of the class and templates, or follow the release note on REST framework upgrades closely.
+
**.media_type**: `text/html`
**.format**: `'.form'`