Commits

Jan-Philip Gehrcke committed 21480a5

Update docs.

Comments (0)

Files changed (3)

 Furthermore, gipc provides gevent-cooperative inter-process communication and
 useful helper constructs.**
 
-``gipc`` is lightweight and very simple to integrate. In the following code
-snippet, a Python object is sent from a greenlet in the main process to a child
+``gipc`` is lightweight and simple to integrate. In the following code snippet,
+a Python object is sent from a greenlet in the main process to a child
 process::
 
     import gevent
             writelet.join()
             readchild.join()
 
-Although very simple, this code would have malicious side effects if used with
+Although quite simple, this code would have malicious side effects if used with
 the canonical ``p = multiprocessing.Process(); p.start()`` instead of
 ``gipc.start_process()``.
 
 
-.. _usage:
-
-Usage
-=====
-
-``gipc``'s interface is small and the usage is pretty simple. Make yourself
-comfortable with ``gipc.start_process()`` and ``gipc.pipe()`` by going through
-the :ref:`examples <examples>` and the :ref:`API <api>` section.
-
-
 What are the challenges and what is gipc's approach?
 ----------------------------------------------------
 
 Can't I just use gevent+multiprocessing?
 ----------------------------------------
 
-A solid application based on ``gevent`` and ``multiprocessing`` requires a lot
-of care and dealing with special cases. ``gipc`` is only a thin wrapper and
-provides the latter. Of course you can do this yourself. Feel free to have a
-look at gipc's code.
+A solid application based on ``gevent`` and ``multiprocessing`` requires care
+and dealing with special cases. ``gipc`` is only a thin wrapper and provides
+the latter. Of course you can do this yourself. Feel free to have a look at
+gipc's code.
+
+
+.. _usage:
+
+Usage
+=====
+
+``gipc``'s interface is small and the usage is pretty simple. Make yourself
+comfortable with ``gipc.start_process()`` and ``gipc.pipe()`` by going through
+the :ref:`examples <examples>` and the :ref:`API <api>` section.
 
 
 .. _technotes:
 
 - gevent >= 1.0 (tested against gevent 1.0rc2). Download gevent
   `here <https://github.com/SiteSupport/gevent/downloads>`_.
-- unit tests pass on Python 2.6 and 2.7.
+- The unit tests are ensured to pass on Python 2.6 and 2.7.
 
 Install via pip
 ---------------
 
 6)  The server greenlet is joined.
 
-Output on my test machine:
-1000 clients served within 0.54 s.
-
 .. code::
 
     import gevent
         s.kill()
         s.join()
 
+Output on my test machine: ``1000 clients served within 0.54 s``.
 
 .. _examplesync:
 

docs/minimal_theme/static/default.css_t

 }
 
 div.documentwrapper {
-    max-width: 700px;
+    max-width: 720px;
     margin-left: auto;
     margin-right: auto;
     margin-top: 80px;
     padding: 3px 0 3px 10px;
 }
 
-div.body h1 { margin-top: 0; font-size: 200%; }
-div.body h2 { font-size: 160%; }
-div.body h3 { font-size: 140%; }
+div.body h1 { margin-top: 0; font-size: 230%; }
+div.body h2 { font-size: 200%; }
+div.body h3 { font-size: 160%; }
 div.body h4 { font-size: 120%; }
 div.body h5 { font-size: 110%; }
 div.body h6 { font-size: 100%; }
 tt {
     //background-color: #ecf0f3;
     padding: 0 1px 0 1px;
-    font-size: 120%;
+    font-size: 110%;
 }
 
 th {
 }
 
 .viewcode-back {
-    font-family: 'Droid Sans', sans-serif;    
+    font-family: 'Droid Sans', sans-serif;
 }
 
 div.viewcode-block:target {
         - proper file descriptor inheritance on Windows.
         - providing cooperative process methods (such as ``join()``).
 
-    Calling this method breaks ``os.waitpid()`` on Unix: spawning the first
-    child activates libev child watchers, leading to libev reap children in the
-    moment they die. Applied to such a child, ``os.waitpid()`` throws
+    Calling :func:`start_process` breaks ``os.waitpid()`` on Unix: spawning the
+    first child activates libev child watchers, leading to libev reap children
+    in the moment they die. Applied to such a child, ``os.waitpid()`` throws
     ``ECHILD`` (cf. http://linux.die.net/man/2/waitid).
     """
     if not isinstance(args, tuple):
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.