[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
scratch/shortdoc 76a3b4e: Start giving example results for non-evaled ex
From: |
Lars Ingebrigtsen |
Subject: |
scratch/shortdoc 76a3b4e: Start giving example results for non-evaled examples |
Date: |
Sun, 27 Sep 2020 17:26:18 -0400 (EDT) |
branch: scratch/shortdoc
commit 76a3b4e3cabf64601d0db5a0eb26527544e3e692
Author: Lars Ingebrigtsen <larsi@gnus.org>
Commit: Lars Ingebrigtsen <larsi@gnus.org>
Start giving example results for non-evaled examples
---
lisp/emacs-lisp/shortdoc.el | 143 +++++++++++++++++++++++++++++++++++++-------
1 file changed, 123 insertions(+), 20 deletions(-)
diff --git a/lisp/emacs-lisp/shortdoc.el b/lisp/emacs-lisp/shortdoc.el
index aed4d0a..8665c2d 100644
--- a/lisp/emacs-lisp/shortdoc.el
+++ b/lisp/emacs-lisp/shortdoc.el
@@ -227,53 +227,143 @@ There can be any number of :example/:result elements."
:example (file-name-quoted-p "/:/tmp/foo")))
(define-short-documentation-group file
+ "Inserting Contents"
+ (insert-file-contents
+ :example-no-eval (insert-file-contents "/tmp/foo")
+ :result ("/tmp/foo" 6))
+ (insert-file-contents-literally
+ :example-no-eval (insert-file-contents-literally "/tmp/foo")
+ :result ("/tmp/foo" 6))
+ (find-file
+ :example-no-eval (find-file "/tmp/foo")
+ :result-string "#<buffer foo>")
"Predicates"
(file-symlink-p
- :example-no-result (file-symlink-p "/tmp/foo"))
+ :example-no-eval (file-symlink-p "/tmp/foo")
+ :result t)
(file-directory-p
- :example-no-result (file-directory-p "/tmp"))
+ :example-no-eval (file-directory-p "/tmp")
+ :result t)
(file-regular-p
- :example-no-result (file-regular-p "/tmp/foo"))
+ :example-no-eval (file-regular-p "/tmp/foo")
+ :result t)
(file-exists-p
- :example-no-result (file-exists-p "/tmp/foo"))
+ :example-no-eval (file-exists-p "/tmp/foo")
+ :result t)
(file-readable-p
- :example-no-result (file-readable-p "/tmp/foo"))
+ :example-no-eval (file-readable-p "/tmp/foo")
+ :result t)
(file-writeable-p
- :example-no-result (file-writeable-p "/tmp/foo"))
+ :example-no-eval (file-writeable-p "/tmp/foo")
+ :result t)
(file-accessible-directory-p
- :example-no-result (file-accessible-directory-p "/tmp"))
+ :example-no-eval (file-accessible-directory-p "/tmp")
+ :result t)
(file-executable-p
- :example-no-result (file-exacutable-p "/bin/cat"))
+ :example-no-eval (file-executable-p "/bin/cat")
+ :result t)
(file-newer-than-file-p
- :example-no-result (file-newer-than-file-p "/tmp/foo" "/tmp/bar"))
+ :example-no-eval (file-newer-than-file-p "/tmp/foo" "/tmp/bar")
+ :result nil)
(file-equal-p
- :example-no-result (file-equal-p "/tmp/foo" "/tmp/bar"))
+ :example-no-eval (file-equal-p "/tmp/foo" "/tmp/bar")
+ :result nil)
(file-in-directory-p
- :example-no-result (file-in-directory-p "foo" "/tmp"))
+ :example-no-eval (file-in-directory-p "/tmp/foo" "/tmp/")
+ :result t)
+ (file-locked-p
+ :example-no-eval (file-locked-p "/tmp/foo")
+ :result nil)
"Information"
(file-attributes
:example-no-result (file-attributes "/tmp"))
(file-truename
- :example-no-result (file-truename "/tmp/foo/bar"))
+ :example-no-eval (file-truename "/tmp/foo/bar")
+ :result "/tmp/foo/zot")
(file-chase-links
- :example-no-result (file-chase-links "/tmp/foo/bar"))
+ :example-no-eval (file-chase-links "/tmp/foo/bar")
+ :result "/tmp/foo/zot")
(vc-responsible-backend
- :example-no-result (vc-responsible-backend "/src/foo/bar.c"))
+ :example-no-eval (vc-responsible-backend "/src/foo/bar.c")
+ :result Git)
(file-acl
- :example-no-result (file-acl "/tmp/foo"))
+ :example-no-eval (file-acl "/tmp/foo")
+ :result "user::rw-\ngroup::r--\nother::r--\n")
(file-extended-attributes
:example-no-result (file-extended-attributes "/tmp/foo"))
(file-selinux-context
:example-no-result (file-selinux-context "/tmp/foo"))
(locate-file
- :example-no-result (locate-file "zot" '("/var" "/usr")))
+ :example-no-eval (locate-file "syslog" '("/var/log" "/usr/bin"))
+ :result "/var/log/syslog")
(executable-find
- :example-no-result (executable-find "ls"))
+ :example-no-eval (executable-find "ls")
+ :result "/usr/bin/ls")
"Creating"
(make-temp-file
- :example-no-result (make-temp-file "/tmp/foo-"))
+ :example-no-eval (make-temp-file "/tmp/foo-")
+ :result "/tmp/foo-ZcXFMj")
(make-nearby-temp-file
- :example-no-result (make-temp-file "/tmp/foo-")))
+ :example-no-eval (make-nearby-temp-file "/tmp/foo-")
+ :result "/tmp/foo-xe8iON")
+ (write-region
+ :example-no-result (write-region (point-min) (point-max) "/tmp/foo"))
+ "Directories"
+ (make-directory
+ :example-no-result (make-directory "/tmp/bar/zot/" t))
+ (directory-files
+ :example-no-eval (directory-files "/tmp/")
+ :result ("." ".." ".ICE-unix" ".Test-unix"))
+ (directory-files-recursively
+ :example-no-eval (directory-files-recursively "/tmp/" "\\.png\\'")
+ :result ("/tmp/foo.png" "/tmp/zot.png" "/tmp/bar/foobar.png"))
+ (directory-files-and-attributes
+ :example-no-result (directory-files-and-attributes "/tmp/foo"))
+ (file-expand-wildcards
+ :example-no-eval (file-expand-wildcards "/tmp/*.png")
+ :result ("/tmp/foo.png" "/tmp/zot.png"))
+ (locate-dominating-file
+ :example-no-eval (locate-dominating-file "foo.png" "/tmp/foo/bar/zot")
+ :result "/tmp/foo.png")
+ (copy-directory
+ :example-no-result (copy-directory "/tmp/bar/" "/tmp/barcopy"))
+ (delete-directory
+ :example-no-result (delete-directory "/tmp/bar/"))
+ "File Operations"
+ (rename-file
+ :example-no-result (rename-file "/tmp/foo" "/tmp/newname"))
+ (copy-file
+ :example-no-result (copy-file "/tmp/foo" "/tmp/foocopy"))
+ (delete-file
+ :example-no-result (delete-file "/tmp/foo"))
+ (make-empty-file
+ :example-no-result (make-empty-file "/tmp/foo"))
+ (make-symbolic-link
+ :example-no-result (make-symbolic-link "/tmp/foo" "/tmp/foosymlink"))
+ (add-name-to-file
+ :example-no-result (add-name-to-file "/tmp/foo" "/tmp/bar"))
+ (set-file-modes
+ :example-no-result (set-file-modes "/tmp/foo" #o644))
+ (set-file-times
+ :example-no-result (set-file-times "/tmp/foo" (current-time)))
+ "File Modes"
+ (set-default-file-modes
+ :example-no-result (set-default-file-modes #o755))
+ (default-file-modes
+ :example-no-result (default-file-modes))
+ (file-modes-symbolic-to-number
+ :example (file-modes-symbolic-to-number "a+r"))
+ (file-modes-number-to-symbolic
+ :example (file-modes-number-to-symbolic #o444))
+ (set-file-extended-attributes
+ :example-no-result (set-file-extended-attributes
+ "/tmp/foo" '((acl . "group::rxx"))))
+ (set-file-selinux-context
+ :example-no-result (set-file-selinux-context
+ "/tmp/foo" '(unconfined_u object_r user_home_t s0)))
+ (set-file-acl
+ :example-no-result (set-file-acl "/tmp/foo" "group::rxx")))
+
(define-short-documentation-group list
"Making Lists"
@@ -503,7 +593,12 @@ There can be any number of :example/:result elements."
(erase-buffer
:example-no-result (erase-buffer))
(insert
- :example-no-result (insert "This string will be inserted in the buffer\n")))
+ :example-no-result (insert "This string will be inserted in the buffer\n"))
+ "Locking"
+ (lock-buffer
+ :example-no-result (lock-buffer "/tmp/foo"))
+ (unlock-buffer
+ :example-no-result (lock-buffer)))
(define-short-documentation-group process
(make-process
@@ -588,9 +683,17 @@ There can be any number of :example/:result elements."
(propertize "[it depends]"
'face 'variable-pitch)
"\n"))
+ (:example-no-eval
+ (insert " ")
+ (prin1 value (current-buffer))
+ (insert "\n"))
(:result
(insert " => ")
(prin1 value (current-buffer))
+ (insert "\n"))
+ (:result-string
+ (insert " -> ")
+ (princ value (current-buffer))
(insert "\n"))))
(put-text-property start (point) 'face 'shortdoc-example))
(insert "\n")))
[Prev in Thread] |
Current Thread |
[Next in Thread] |
- scratch/shortdoc 76a3b4e: Start giving example results for non-evaled examples,
Lars Ingebrigtsen <=