[elpa] master 0ddafcf 131/187: Merge pull request #41 from PhilHudson/master

[Michael Albinus]

branch: master
commit 0ddafcfb4a683097a7cc4db9830b25bb16d8bd99
Merge: d990787 8bb0876
Author: John Wiegley <address@hidden>
Commit: John Wiegley <address@hidden>

    Merge pull request #41 from PhilHudson/master
    
    Markup corrections to README.md
---
 README.md |   28 ++++++++++++++--------------
 1 files changed, 14 insertions(+), 14 deletions(-)

diff --git a/README.md b/README.md
index c132a97..f34b2ab 100644
--- a/README.md
+++ b/README.md
@@ -1,10 +1,10 @@
 # emacs-async
 
-async.el is a module for doing asynchronous processing in Emacs.
+`async.el` is a module for doing asynchronous processing in Emacs.
 
 # Install
 
-Add to your .emacs.el:
+Add to your `.emacs.el`:
 
      (when (require 'dired-aux)
        (require 'dired-async))
@@ -41,8 +41,8 @@ done, the return value is passed to FINISH-FUNC.  Example:
        (lambda (result)
          (message "Async process done, result should be 222: %s" result)))
              
-If FINISH-FUNC is nil or missing, a future is returned that can be inspected
-using `async-get', blocking until the value is ready.  Example:
+If FINISH-FUNC is `nil` or missing, a future is returned that can be inspected
+using `async-get`, blocking until the value is ready.  Example:
 
     (let ((proc (async-start
                    ;; What to do in the child process
@@ -58,7 +58,7 @@ using `async-get', blocking until the value is ready.  
Example:
 
 If you don't want to use a callback, and you don't care about any return value
 form the child process, pass the `'ignore` symbol as the second argument (if
-you don't, and never call `async-get`, it will leave *emacs* process buffers
+you don't, and never call `async-get`, it will leave ``*emacs*`` process 
buffers
 hanging around):
 
     (async-start
@@ -67,17 +67,17 @@ hanging around):
      'ignore)
 
 Note: Even when FINISH-FUNC is present, a future is still returned except that
-it yields no value (since the value is passed to FINISH-FUNC).  Call
-`async-get' on such a future always returns nil.  It can still be useful,
-however, as an argument to `async-ready' or `async-wait'.
+it yields no value (since the value is passed to FINISH-FUNC).  Calling
+`async-get` on such a future always returns `nil`.  It can still be useful,
+however, as an argument to `async-ready` or `async-wait`.
 
 ## async-start-process
 
     async-start-process NAME PROGRAM FINISH-FUNC &rest PROGRAM-ARGS
     
-Start the executable PROGRAM asynchronously.  See `async-start'.  PROGRAM is
+Start the executable PROGRAM asynchronously.  See `async-start`.  PROGRAM is
 passed PROGRAM-ARGS, calling FINISH-FUNC with the process object when done.
-If FINISH-FUNC is nil, the future object will return the process object when
+If FINISH-FUNC is `nil`, the future object will return the process object when
 the program is finished.
 
 ## async-get
@@ -85,15 +85,15 @@ the program is finished.
     async-get FUTURE
     
 Get the value from an asynchronously function when it is ready.  FUTURE is
-returned by `async-start' or `async-start-process' when its FINISH-FUNC is
-nil.
+returned by `async-start` or `async-start-process` when its FINISH-FUNC is
+`nil`.
 
 ## async-ready
 
     async-ready FUTURE
 
 Query a FUTURE to see if the ready is ready -- i.e., if no blocking
-would result from a call to `async-get' on that FUTURE.
+would result from a call to `async-get` on that FUTURE.
 
 ## async-wait
 
@@ -105,7 +105,7 @@ Wait for FUTURE to become ready.
 
     async-inject-variables INCLUDE-REGEXP &optional PREDICATE EXCLUDE-REGEXP
 
-Return a `setq' form that replicates part of the calling environment.  It sets
+Return a `setq` form that replicates part of the calling environment.  It sets
 the value for every variable matching INCLUDE-REGEXP and also PREDICATE.  It
 will not perform injection for any variable matching EXCLUDE-REGEXP (if
 present).  It is intended to be used as follows: