Skip to content

Commit

Permalink
make the documentation consistent.
Browse files Browse the repository at this point in the history
  • Loading branch information
zonotope committed Jan 15, 2018
1 parent ba37fe7 commit c558a14
Showing 1 changed file with 8 additions and 7 deletions.
15 changes: 8 additions & 7 deletions rg.el
Original file line number Diff line number Diff line change
Expand Up @@ -1014,9 +1014,9 @@ prefix is not supplied `rg-keymap-prefix' is used."
(eval-when-compile
(defun rg-set-search-defaults (args)
"Set defaults for required search options missing from ARGS.
If the :confirm option is missing, set it to 'never, if
the :format option is missing, set it to 'regexp, and if
the :query option is missing, set it to 'ask"
If the :confirm option is missing, set it to NEVER, if
the :format option is missing, set it to REGEXP, and if
the :query option is missing, set it to ASK"
(unless (plist-get args :confirm)
(setq args (plist-put args :confirm 'never)))

Expand Down Expand Up @@ -1102,10 +1102,11 @@ the :query option is missing, set it to 'ask"
;;;###autoload
(defmacro rg-define-search (name &rest args)
"Define an rg search functions named NAME.
ARGS is a search specification with `:query' (point or ask),
`:format' (literal or regexp), `files' (rg or custom file alias),
`dir' (root search directory), and `confirm' as allowable options
specifying the behavior of the search function."
ARGS is a search specification with :query (POINT or ASK),
:format (LITERAL or REGEXP), :files (rg or custom file alias),
:dir (root search directory), and :confirm (NEVER, ALWAYS, or
PREFIX) as allowable options specifying the behavior of the
search function."
(declare (indent defun))
(let* ((body (rg-search-parse-body args))
(decls (car body))
Expand Down

0 comments on commit c558a14

Please sign in to comment.