branch: master
commit 846426104be05cad84c9a62cd69fa2b4b8b8289f
Author: Phil Hudson <[email protected]>
Commit: Phil Hudson <[email protected]>
Changed symbol markup from Lisp idiom to Markdown
Changed `foo' to `foo` throughout.
---
README.md | 16 ++++++++--------
1 files changed, 8 insertions(+), 8 deletions(-)
diff --git a/README.md b/README.md
index c132a97..6c3c7df 100644
--- a/README.md
+++ b/README.md
@@ -42,7 +42,7 @@ done, the return value is passed to FINISH-FUNC. Example:
(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:
+using `async-get`, blocking until the value is ready. Example:
(let ((proc (async-start
;; What to do in the child process
@@ -67,15 +67,15 @@ 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
the program is finished.
@@ -85,7 +85,7 @@ 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
+returned by `async-start` or `async-start-process` when its FINISH-FUNC is
nil.
## async-ready
@@ -93,7 +93,7 @@ nil.
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:
