From f68596a7326777f971d9551ff1bfc7176389ea22 Mon Sep 17 00:00:00 2001
From: Miro Hrončok
Date: Thu, 10 Apr 2014 01:58:06 +0200
Subject: Document new UnicodeYAMLRenderer

---
 docs/api-guide/renderers.md | 20 ++++++++++++++++++++
 1 file changed, 20 insertions(+)

(limited to 'docs/api-guide')

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'`
-- 
cgit v1.2.3