aboutsummaryrefslogtreecommitdiffstats
path: root/docs/emitters.rst
diff options
context:
space:
mode:
Diffstat (limited to 'docs/emitters.rst')
-rw-r--r--docs/emitters.rst8
1 files changed, 6 insertions, 2 deletions
diff --git a/docs/emitters.rst b/docs/emitters.rst
index fc96e71f..fcea6151 100644
--- a/docs/emitters.rst
+++ b/docs/emitters.rst
@@ -1,5 +1,9 @@
-Emitters
-========
+:mod:`emitters`
+===============
+
+.. module:: emitters
+
+The emitters module provides a set of emitters that can be plugged in to a :class:`.Resource`. An emitter is responsible for taking the output of a and serializing it to a given media type. A :class:`.Resource` can have a number of emitters, allow the same content to be serialized in a number of different formats depending on the requesting client's preferences, as specified in the HTTP Request's Accept header.
.. automodule:: emitters
:members: