aboutsummaryrefslogtreecommitdiffstats
path: root/docs/api-guide/renderers.md
diff options
context:
space:
mode:
authorMiro Hrončok2014-04-10 01:58:06 +0200
committerMiro Hrončok2014-04-10 01:58:06 +0200
commitf68596a7326777f971d9551ff1bfc7176389ea22 (patch)
tree102fc990af0b4001aab9fde1713f6002b28e1c92 /docs/api-guide/renderers.md
parent7ae8409370635ccec7d3c160ea87281f21c9ae11 (diff)
downloaddjango-rest-framework-f68596a7326777f971d9551ff1bfc7176389ea22.tar.bz2
Document new UnicodeYAMLRenderer
Diffstat (limited to 'docs/api-guide/renderers.md')
-rw-r--r--docs/api-guide/renderers.md20
1 files changed, 20 insertions, 0 deletions
diff --git a/docs/api-guide/renderers.md b/docs/api-guide/renderers.md
index 7798827b..7a3429bf 100644
--- a/docs/api-guide/renderers.md
+++ b/docs/api-guide/renderers.md
@@ -138,6 +138,26 @@ Renders the request data into `YAML`.
Requires the `pyyaml` package to be installed.
+Note that non-ascii characters will be rendered using `\uXXXX` character escape. For example:
+
+ unicode black star: "\u2605"
+
+**.media_type**: `application/yaml`
+
+**.format**: `'.yaml'`
+
+**.charset**: `utf-8`
+
+## UnicodeYAMLRenderer
+
+Renders the request data into `YAML`.
+
+Requires the `pyyaml` package to be installed.
+
+Note that non-ascii characters will not be character escaped. For example:
+
+ unicode black star: ★
+
**.media_type**: `application/yaml`
**.format**: `'.yaml'`