[Top][All Lists]

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

[elpa] externals/objed d0bc8c7 165/216: Update docs for ipipe

From: Stefan Monnier
Subject: [elpa] externals/objed d0bc8c7 165/216: Update docs for ipipe
Date: Tue, 8 Jan 2019 12:29:32 -0500 (EST)

branch: externals/objed
commit d0bc8c771c775f59b64277fe99b6a0381563b43e
Author: Clemera <address@hidden>
Commit: Clemera <address@hidden>

    Update docs for ipipe
 README.asc |  3 +++
 objed.el   | 18 ++++++++++++++++--
 2 files changed, 19 insertions(+), 2 deletions(-)

diff --git a/README.asc b/README.asc
index 88663a2..91a67a2 100644
--- a/README.asc
+++ b/README.asc
@@ -330,6 +330,9 @@ commands" below):
 |Pipe object region through shell command.
+|Interactively pipe object region through shell or region command.
 |Flyspell textual content of object.
diff --git a/objed.el b/objed.el
index 97d789c..59beb2d 100644
--- a/objed.el
+++ b/objed.el
@@ -2580,14 +2580,17 @@ c: capitalize."
 (defvar objed--ipipe-schedule-time 0.15
   "Time frame to update the display.")
-(defvar objed--ipipe-timer nil)
+(defvar objed--ipipe-timer nil
+  "Timer used for `objed-ipipe'.")
 (defun objed--ipipe-reset-timer ()
+  "Reset timer used `objed--ipipe-timer'."
   (when objed--ipipe-timer
     (cancel-timer objed--ipipe-timer))
   (setq objed--ipipe-timer nil))
 (defun objed--ipipe-schedule-timer (&rest _)
+  "Schedule timer `objed--ipipe-timer'."
   (let ((mini (window-buffer (active-minibuffer-window))))
     (setq objed--ipipe-timer
@@ -2633,6 +2636,9 @@ c: capitalize."
 (defun objed--ipipe-parse (str)
+  "Parse string STR.
+Returns cons cell with cmd as car and possible arguemtns as cdr."
     (insert str)
     (goto-char (point-min))
@@ -2642,6 +2648,9 @@ c: capitalize."
 (defun objed--ipipe-to-string (cmd-args str)
+  "Pipe string STR through CMD-ARGS.
+Return restult if any or nil."
   (let* ((cmdline (minibuffer-contents))
          (parsed (objed--ipipe-parse cmdline))
          (cmd (car-safe parsed))
@@ -2690,7 +2699,9 @@ Exit if there is no content."
 (defun objed-ipipe-complete ()
-  "Complete for shell commands and region commands."
+  "Completion used by `objed-ipipe'.
+Completes shell and region commands."
   (let ((bounds (or (bounds-of-thing-at-point 'symbol)
                                            (cons (point)
@@ -2709,6 +2720,9 @@ Exit if there is no content."
 ;; ** Entry command
 (defun objed-ipipe (beg end)
+  "Pipe region between BED END through commands.
+Commands can be shell commands or region commands."
   (interactive "r")
   ;; init
   (setq objed--ipipe-last "")

reply via email to

[Prev in Thread] Current Thread [Next in Thread]