[nongnu] elpa/with-editor d3b0bc7 083/140: Update documentation

[Jonas Bernoulli]

branch: elpa/with-editor
commit d3b0bc766371fa6dc2f413a619f2e9717f3d1f24
Author: Jonas Bernoulli <jonas@bernoul.li>
Commit: Jonas Bernoulli <jonas@bernoul.li>

    Update documentation
---
 with-editor.el   | 13 ++++++++-----
 with-editor.org  | 19 ++++++++++++-------
 with-editor.texi | 16 ++++++++++------
 3 files changed, 30 insertions(+), 18 deletions(-)

diff --git a/with-editor.el b/with-editor.el
index 59cddbb..ba01946 100644
--- a/with-editor.el
+++ b/with-editor.el
@@ -202,15 +202,18 @@ with \"bash\" (and install that), or you can use the 
older, less
 performant implementation:
 
   \"sh -c '\\
-  echo \\\"WITH-EDITOR: $$ OPEN $0 in $(pwd)\\\"; \\
+  echo \\\"WITH-EDITOR: $$ OPEN $0 IN $(pwd)\\\"; \\
   trap \\\"exit 0\\\" USR1; \\
   trap \\\"exit 1\" USR2; \\
   while true; do sleep 1; done'\"
 
-Note that this leads to a delay of up to a second.  The delay can
-be shortened by replacing \"sleep 1\" with \"sleep 0.01\", or if your
-implementation does not support floats, then by using `nanosleep'
-instead."
+Note that the unit seperator character () right after the file
+name ($0) is required.
+
+Also note that using this alternative implementation leads to a
+delay of up to a second.  The delay can be shortened by replacing
+\"sleep 1\" with \"sleep 0.01\", or if your implementation does
+not support floats, then by using \"nanosleep\" instead."
   :package-version '(with-editor . "2.8.0")
   :group 'with-editor
   :type 'string)
diff --git a/with-editor.org b/with-editor.org
index 329b83e..66406a5 100644
--- a/with-editor.org
+++ b/with-editor.org
@@ -8,7 +8,7 @@
 #+TEXINFO_DIR_CATEGORY: Emacs
 #+TEXINFO_DIR_TITLE: With-Editor: (with-editor).
 #+TEXINFO_DIR_DESC: Using the Emacsclient as $EDITOR
-#+SUBTITLE: for version 2.7.4
+#+SUBTITLE: for version 2.7.4 (v2.7.4-2-g48e1b2d+1)
 #+BIND: ox-texinfo+-before-export-hook ox-texinfo+-update-version-strings
 
 #+TEXINFO_DEFFN: t
@@ -30,7 +30,7 @@ additional functionality which makes it useful even for 
end-users, who
 don't use Magit or another package which uses it internally.
 
 #+TEXINFO: @noindent
-This manual is for With-Editor version 2.7.4.
+This manual is for With-Editor version 2.7.4 (v2.7.4-2-g48e1b2d+1).
 
 #+BEGIN_QUOTE
 Copyright (C) 2015-2018 Jonas Bernoulli <jonas@bernoul.li>
@@ -135,15 +135,19 @@ it receives a signal.
 
   #+BEGIN_SRC emacs-lisp
     "sh -c '\
-    echo \"WITH-EDITOR: $$ OPEN $0\"; \
+    echo \"WITH-EDITOR: $$ OPEN $0 IN $(pwd)\"; \
     trap \"exit 0\" USR1; \
     trap \"exit 1\" USR2; \
     while true; do sleep 1; done'"
   #+END_SRC
 
-  This leads to a delay of up to a second.  The delay can be shortened
-  by replacing ~sleep 1~ with ~sleep 0.01~, or if your implementation does
-  not support floats, then by using ~nanosleep 0.01~ instead.
+  Note that the unit seperator character () right after the file
+  name ($0) is required.
+
+  Also note that using this alternative implementation leads to a
+  delay of up to a second.  The delay can be shortened by replacing
+  ~sleep 1~ with ~sleep 0.01~, or if your implementation does not support
+  floats, then by using ~nanosleep~ instead.
 
 ** Using With-Editor commands
 
@@ -302,7 +306,8 @@ General Public License for more details.
 
 # IMPORTANT: Also update ORG_ARGS and ORG_EVAL in the Makefile.
 # Local Variables:
-# eval: (require 'ox-extra nil t)
+# eval: (require 'magit-utils nil t)
+# eval: (require 'ox-extra    nil t)
 # eval: (require 'ox-texinfo+ nil t)
 # eval: (and (featurep 'ox-extra) (ox-extras-activate '(ignore-headlines)))
 # indent-tabs-mode: nil
diff --git a/with-editor.texi b/with-editor.texi
index 0cb5685..4ebb1c7 100644
--- a/with-editor.texi
+++ b/with-editor.texi
@@ -30,7 +30,7 @@ General Public License for more details.
 @finalout
 @titlepage
 @title With-Editor User Manual
-@subtitle for version 2.7.4
+@subtitle for version 2.7.4 (v2.7.4-2-g48e1b2d+1)
 @author Jonas Bernoulli
 @page
 @vskip 0pt plus 1filll
@@ -59,7 +59,7 @@ additional functionality which makes it useful even for 
end-users, who
 don't use Magit or another package which uses it internally.
 
 @noindent
-This manual is for With-Editor version 2.7.4.
+This manual is for With-Editor version 2.7.4 (v2.7.4-2-g48e1b2d+1).
 
 @quotation
 Copyright (C) 2015-2018 Jonas Bernoulli <jonas@@bernoul.li>
@@ -190,15 +190,19 @@ implementation:
 
 @lisp
 "sh -c '\
-echo \"WITH-EDITOR: $$ OPEN $0\"; \
+echo \"WITH-EDITOR: $$ OPEN $0 IN $(pwd)\"; \
 trap \"exit 0\" USR1; \
 trap \"exit 1\" USR2; \
 while true; do sleep 1; done'"
 @end lisp
 
-This leads to a delay of up to a second.  The delay can be shortened
-by replacing @code{sleep 1} with @code{sleep 0.01}, or if your implementation 
does
-not support floats, then by using @code{nanosleep 0.01} instead.
+Note that the unit seperator character () right after the file
+name ($0) is required.
+
+Also note that using this alternative implementation leads to a
+delay of up to a second.  The delay can be shortened by replacing
+@code{sleep 1} with @code{sleep 0.01}, or if your implementation does not 
support
+floats, then by using @code{nanosleep} instead.
 @end defopt
 
 @node Using With-Editor commands