doc fixes

docs/apps/wsgi/content.rst

@@ -18,7 +18,7 @@ Design
 ===============
 
 The :meth:`~String.stream` method is responsible for the streaming
-of ``strings`` or :ref:`asynchronous components  <tutorials-coroutine>`.
+of ``strings``.
 It can be overwritten by subclasses to customise the way an
 :class:`String` streams its :attr:`~String.children`.
 

docs/apps/wsgi/tools.rst

@@ -2,14 +2,6 @@
 Utilities
 =====================
 
-HTTP Parsers
-================
-
-Pulsar ships with its own :ref:`HTTP parser <tools-http-parser>` used by
-both server and the :ref:`HTTP client <apps-http>`. Headers are collected using
-the :ref:`Headers data structure <tools-http-headers>` which exposes a
-list/dictionary-type interface.
-
 
 Authentication
 =================

docs/faq.rst

@@ -27,10 +27,6 @@ What is an actor?
 ~~~~~~~~~~~~~~~~~~~~~~
 Check the :ref:`actor design documentation <design-actor>`.
 
-How pulsar handle asynchronous data?
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-Check the :ref:`asynchronous components documentation <tutorials-coroutine>`.
-
 How is pulsar different from Twisted?
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 Pulsar is written for python 3.4 or above, Twisted is python 2. Pulsar is written

pulsar/apps/wsgi/content.py

@@ -168,13 +168,7 @@ def append_to(self, parent):
         return self
 
     def stream(self, request, counter=0):
-        '''Returns an iterable over strings or asynchronous components.
-
-        If :ref:`asynchronous elements <tutorials-coroutine>` are included
-        in the iterable, when called, they must result in strings.
-        This method can be re-implemented by subclasses and should not be
-        invoked directly.
-        Use the :meth:`stream` method instead.
+        '''Returns an iterable over strings.
         '''
         if self._children:
             for child in self._children:
@@ -576,7 +570,7 @@ class Links(Media):
     '''A :class:`.Media` container for ``link`` tags.
 
     The ``<link>`` tag defines the relationship between a
-    :class:`.HtmlDocument` and an external resource.
+    :class:`~.HtmlDocument` and an external resource.
     It is most used to link to style sheets.
     '''
     mediatype = 'css'

pulsar/async/futures.py

@@ -72,9 +72,6 @@ def _error_back(fut):
 def maybe_async(value, *, loop=None):
     '''Handle a possible asynchronous ``value``.
 
-    Return an :ref:`asynchronous instance <tutorials-coroutine>`
-    only if ``value`` is a generator, a :class:`.Future`.
-
     :parameter value: the value to convert to an asynchronous instance
         if it needs to.
     :parameter loop: optional :class:`.EventLoop`.

pulsar/utils/pylib/events.py

@@ -32,6 +32,10 @@ def onetime(self):
         return bool(self._onetime)
 
     def fired(self):
+        """Returns true or false depending if this event was fired
+
+        One-time events only can be fired
+        """
         return self._self is None
 
     def bind(self, callback):
@@ -62,6 +66,11 @@ def unbind(self, callback):
         return 0
 
     def fire(self, exc=None, data=None):
+        """Fire the event
+
+        :param exc: fire the event with an exception
+        :param data: fire an event with data
+        """
         o = self._self
 
         if o is not None:
@@ -89,6 +98,13 @@ def fire(self, exc=None, data=None):
                 self._waiter = None
 
     def waiter(self):
+        """Return a :class:`~asyncio.Future` called back once the event
+        has been fired.
+        If the event has been fired already return a resolved future.
+
+        This method is available only for one-time events
+        """
+        assert self._onetime, 'One time events only can invoke waiter'
         if not self._waiter:
             self._waiter = get_event_loop().create_future()
             if self.fired():

requirements/docs.txt

@@ -1,2 +1,4 @@
 recommonmark
 sphinxcontrib-spelling
+flask
+greenlet