Add warning against HTMLFormRenderer

This commit is contained in:
Tom Christie 2013-08-25 20:31:04 +01:00
parent c7847ebc45
commit 53d60543c3

View File

@ -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'`