[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[elpa] externals/el-search a20a333 171/332: Use a separate function to d
From: |
Stefan Monnier |
Subject: |
[elpa] externals/el-search a20a333 171/332: Use a separate function to document defined pattern types |
Date: |
Tue, 1 Dec 2020 15:48:37 -0500 (EST) |
branch: externals/el-search
commit a20a333d38113f9444e2e6502335c74425aba0f8
Author: Michael Heerdegen <michael_heerdegen@web.de>
Commit: Michael Heerdegen <michael_heerdegen@web.de>
Use a separate function to document defined pattern types
---
el-search.el | 17 ++++++++++++-----
1 file changed, 12 insertions(+), 5 deletions(-)
diff --git a/el-search.el b/el-search.el
index ed7aae9..7625b8c 100644
--- a/el-search.el
+++ b/el-search.el
@@ -682,12 +682,20 @@ not be inside a string or comment."
Keys are pattern names (i.e. symbols) and values the associated
expander functions.")
+(defun el-search-defined-patterns ()
+ "Return a list of defined el-search patterns."
+ (mapcar #'car el-search--pcase-macros))
+
+(put 'el-search-defined-patterns 'function-documentation
+ '(el-search--make-docstring 'el-search-defined-patterns))
+
(defun el-search--make-docstring (name)
;; Code mainly from `pcase--make-docstring'
(let* ((main (documentation (symbol-function name) 'raw))
(ud (help-split-fundoc main name)))
(with-temp-buffer
- (insert (or (cdr ud) main))
+ (insert (or (cdr ud) main)
+ "\n\nThe following additional pattern types are currently
defined:")
(mapc
(pcase-lambda (`(,symbol . ,fun))
(unless (string-match-p "\\`[-_]\\|--" (symbol-name symbol)) ;Let's
consider these "internal"
@@ -1925,8 +1933,9 @@ details.
PATTERN is an \"el-search\" pattern - which means, either a
`pcase' pattern or complying with one of the additional pattern
-types defined with `el-search-defpattern'. The following
-additional pattern types are currently defined:"
+types defined with `el-search-defpattern'.
+
+See `el-search-defined-patterns' for a list of defined patterns."
(declare (interactive-only el-search-forward))
(interactive (el-search-pattern--interactive))
(cond
@@ -1949,8 +1958,6 @@ additional pattern types are currently defined:"
(lambda (search) (setf (alist-get 'is-single-buffer
(el-search-object-properties search)) t))
'from-here))))
-(put 'el-search-pattern 'function-documentation '(el-search--make-docstring
'el-search-pattern))
-
(defun el-search-from-beginning (&optional restart-search)
"Go to the first of this buffer's matches.
With prefix arg, restart the current search."
- [elpa] externals/el-search 33c14a4 103/332: Move some pattern definitions to new file "el-search-x", (continued)
- [elpa] externals/el-search 33c14a4 103/332: Move some pattern definitions to new file "el-search-x", Stefan Monnier, 2020/12/01
- [elpa] externals/el-search c4d8e00 105/332: el-search--make-docstring: exclude some specially named patterns, Stefan Monnier, 2020/12/01
- [elpa] externals/el-search 0735984 120/332: el-search: more cleanup and minor tweaks; version 1.0.1, Stefan Monnier, 2020/12/01
- [elpa] externals/el-search 6292dcc 130/332: Fix disregarding compressed elisp files, Stefan Monnier, 2020/12/01
- [elpa] externals/el-search 788db9d 135/332: Use regexp-opt on suffixes in el-search--elisp-file-name-p, Stefan Monnier, 2020/12/01
- [elpa] externals/el-search e7e900c 145/332: Use `read' to circumvent bug#24542, Stefan Monnier, 2020/12/01
- [elpa] externals/el-search 8e6466a 131/332: Set syntax table for temp buffers in el-search-atom-list, Stefan Monnier, 2020/12/01
- [elpa] externals/el-search cdfe8c1 136/332: Call `user-error' instead of `error' where appropriate, Stefan Monnier, 2020/12/01
- [elpa] externals/el-search 5fbbcd1 168/332: Restore current search head in case of error or quit, Stefan Monnier, 2020/12/01
- [elpa] externals/el-search 6e4b9cc 170/332: Show line numbers in *El Occur* buffers, Stefan Monnier, 2020/12/01
- [elpa] externals/el-search a20a333 171/332: Use a separate function to document defined pattern types,
Stefan Monnier <=
- [elpa] externals/el-search 79ab903 179/332: Always use the current search for query-replace, Stefan Monnier, 2020/12/01
- [elpa] externals/el-search 6a7ca23 181/332: Don't limit `el-search-emacs-elisp-sources' to "lisp/" subdir, Stefan Monnier, 2020/12/01
- [elpa] externals/el-search 8dc608e 187/332: Improve folding behavior in *El Occur* buffers, Stefan Monnier, 2020/12/01
- [elpa] externals/el-search a2e367e 189/332: Fix starting a search with `el-search-this-sexp', Stefan Monnier, 2020/12/01
- [elpa] externals/el-search d1706eb 190/332: Display match count for *El Occur* buffers, Stefan Monnier, 2020/12/01
- [elpa] externals/el-search 97626ac 192/332: Use local binding of `post-command-hook' to reset wrap flag, Stefan Monnier, 2020/12/01
- [elpa] externals/el-search 16a5f70 193/332: * el-search/el-search.el: Shorten the query-replace prompt, Stefan Monnier, 2020/12/01
- [elpa] externals/el-search 224f384 196/332: ; * el-search/el-search.el: Mention Emacs Bug#29857 in the header, Stefan Monnier, 2020/12/01
- [elpa] externals/el-search 1175d21 200/332: Allow `string' and `symbol' el-search patterns to set match data, Stefan Monnier, 2020/12/01
- [elpa] externals/el-search b88b65a 204/332: Declare any search started with `el-search-this-sexp' single-buffer, Stefan Monnier, 2020/12/01