branch: externals/taxy
commit effc251fa3f8a86981cf8babe6abf726452cc452
Author: Adam Porter <a...@alphapapa.net>
Commit: Adam Porter <a...@alphapapa.net>
Docs: Add shortdoc group for Emacs 28
---
README.org | 6 ++-
taxy.el | 69 +++++++++++++++++++++++++++++++++
taxy.info | 127 +++++++++++++++++++++++++++++++++++--------------------------
3 files changed, 146 insertions(+), 56 deletions(-)
diff --git a/README.org b/README.org
index d114c9a..2a9eba4 100644
--- a/README.org
+++ b/README.org
@@ -881,6 +881,8 @@ Note that while =taxy-magit-section.el= is installed with
the =taxy= package, th
** Reference
+In Emacs 28+, see also =M-x shortdoc-display-group RET taxy RET=.
+
*** Functions
- taxy-flatten (taxy) ::
@@ -933,7 +935,9 @@ Note that while =taxy-magit-section.el= is installed with
the =taxy= package, th
** 0.8-pre
-Nothing new yet.
+*** Additions
+
++ Short documentation group for Emacs 28+.
** 0.7
diff --git a/taxy.el b/taxy.el
index 10b51d3..9c423c5 100644
--- a/taxy.el
+++ b/taxy.el
@@ -358,6 +358,75 @@ defined with a definer defined by
`taxy-define-key-definer')."
`(lambda (item taxy)
(taxy-take-keyed ',keys item taxy)))))
+;;;; Documentation group
+
+;; Available in Emacs 28.
+
+(when (require 'shortdoc nil t)
+ (define-short-documentation-group taxy
+ (taxy-flatten
+ :eval (taxy-flatten
+ (make-taxy
+ :items '(a b c)
+ :taxys (list (make-taxy
+ :items '(d e f))))))
+ (taxy-emptied
+ :eval (taxy-emptied
+ (make-taxy
+ :items '(a b c)
+ :taxys (list (make-taxy
+ :items '(d e f))))))
+ (taxy-fill
+ :eval (taxy-fill '(0 1 2 3)
+ (make-taxy
+ :name "Numbers"
+ :taxys (list (make-taxy
+ :name "Odd"
+ :predicate #'cl-oddp)
+ (make-taxy
+ :name "Even"
+ :predicate #'cl-evenp)))))
+ (taxy-make-take-function
+ :eval (taxy-make-take-function
+ '(first-char second-char)
+ '((first-char (lambda (s) (substring s nil 1)))
+ (second-char (lambda (s) (substring s 1 2))))))
+ (taxy-mapc-taxys
+ :eval (taxy-mapc-taxys
+ (lambda (taxy)
+ (setf (taxy-name taxy) (upcase (taxy-name taxy))))
+ (make-taxy :name "a" :taxys (list (make-taxy :name "b")))))
+ (taxy-mapcar-items
+ :eval (taxy-mapcar-items #'upcase
+ (make-taxy :items (list "a" "b" "c")
+ :taxys (list (make-taxy :items (list "d" "e" "f"))))))
+ (taxy-plain
+ :eval (taxy-plain
+ (taxy-fill '(0 1 2 3)
+ (make-taxy
+ :name "Numbers"
+ :taxys (list (make-taxy
+ :name "Odd"
+ :predicate #'cl-oddp)
+ (make-taxy
+ :name "Even"
+ :predicate #'cl-evenp))))))
+ (taxy-size
+ :eval (taxy-size
+ (make-taxy
+ :items '(a b c)
+ :taxys (list (make-taxy
+ :items '(d e f))))))
+ (taxy-sort-items
+ :eval (taxy-sort-items #'string< #'identity
+ (make-taxy :items (list "c" "b" "a")
+ :taxys (list (make-taxy :items (list "f" "e" "d"))))))
+ (taxy-sort-taxys
+ :eval (taxy-sort-taxys #'string< #'taxy-name
+ (make-taxy :name "Taxy"
+ :taxys (list (make-taxy :name "Beta")
+ (make-taxy :name "Alpha")))))))
+
;;;; Footer
(provide 'taxy)
diff --git a/taxy.info b/taxy.info
index 54e289b..2b83405 100644
--- a/taxy.info
+++ b/taxy.info
@@ -85,17 +85,21 @@ Changelog
* 0.2: 02.
* 0.1: 01.
-0.7
+0.8-pre
* Additions::
-0.6
+0.7
* Additions: Additions (1).
-0.5
+0.6
* Additions: Additions (2).
+
+0.5
+
+* Additions: Additions (3).
* Fixes::
0.3
@@ -106,7 +110,7 @@ Changelog
0.2
* Changes: Changes (1).
-* Additions: Additions (3).
+* Additions: Additions (4).
* Fixes: Fixes (2).
Development
@@ -1038,6 +1042,8 @@ File: README.info, Node: Reference, Prev: Magit
section, Up: Usage
3.6 Reference
=============
+In Emacs 28+, see also ‘M-x shortdoc-display-group RET taxy RET’.
+
* Menu:
* Functions::
@@ -1138,7 +1144,17 @@ File: README.info, Node: 08-pre, Next: 07, Up:
Changelog
4.1 0.8-pre
===========
-Nothing new yet.
+* Menu:
+
+* Additions::
+
+
+File: README.info, Node: Additions, Up: 08-pre
+
+4.1.1 Additions
+---------------
+
+ • Short documentation group for Emacs 28+.
File: README.info, Node: 07, Next: 06, Prev: 08-pre, Up: Changelog
@@ -1148,10 +1164,10 @@ File: README.info, Node: 07, Next: 06, Prev: 08-pre,
Up: Changelog
* Menu:
-* Additions::
+* Additions: Additions (1).
-File: README.info, Node: Additions, Up: 07
+File: README.info, Node: Additions (1), Up: 07
4.2.1 Additions
---------------
@@ -1170,10 +1186,10 @@ File: README.info, Node: 06, Next: 05, Prev: 07,
Up: Changelog
* Menu:
-* Additions: Additions (1).
+* Additions: Additions (2).
-File: README.info, Node: Additions (1), Up: 06
+File: README.info, Node: Additions (2), Up: 06
4.3.1 Additions
---------------
@@ -1210,11 +1226,11 @@ File: README.info, Node: 05, Next: 04, Prev: 06,
Up: Changelog
* Menu:
-* Additions: Additions (2).
+* Additions: Additions (3).
* Fixes::
-File: README.info, Node: Additions (2), Next: Fixes, Up: 05
+File: README.info, Node: Additions (3), Next: Fixes, Up: 05
4.4.1 Additions
---------------
@@ -1236,7 +1252,7 @@ File: README.info, Node: Additions (2), Next: Fixes,
Up: 05
• New example ‘taxy-package-report’.
-File: README.info, Node: Fixes, Prev: Additions (2), Up: 05
+File: README.info, Node: Fixes, Prev: Additions (3), Up: 05
4.4.2 Fixes
-----------
@@ -1295,11 +1311,11 @@ File: README.info, Node: 02, Next: 01, Prev: 03,
Up: Changelog
* Menu:
* Changes: Changes (1).
-* Additions: Additions (3).
+* Additions: Additions (4).
* Fixes: Fixes (2).
-File: README.info, Node: Changes (1), Next: Additions (3), Up: 02
+File: README.info, Node: Changes (1), Next: Additions (4), Up: 02
4.7.1 Changes
-------------
@@ -1309,7 +1325,7 @@ File: README.info, Node: Changes (1), Next: Additions
(3), Up: 02
reason to maintain two versions.
-File: README.info, Node: Additions (3), Next: Fixes (2), Prev: Changes (1),
Up: 02
+File: README.info, Node: Additions (4), Next: Fixes (2), Prev: Changes (1),
Up: 02
4.7.2 Additions
---------------
@@ -1327,7 +1343,7 @@ File: README.info, Node: Additions (3), Next: Fixes
(2), Prev: Changes (1),
.
-File: README.info, Node: Fixes (2), Prev: Additions (3), Up: 02
+File: README.info, Node: Fixes (2), Prev: Additions (4), Up: 02
4.7.3 Fixes
-----------
@@ -1391,46 +1407,47 @@ GPLv3
Tag Table:
Node: Top218
-Node: Examples2181
-Node: Numbery (starting basically)2500
-Node: Lettery (filling incrementally)8261
-Node: Sporty (understanding completely)10775
-Node: Applications16762
-Node: Installation17237
-Node: Usage17550
-Node: Reusable taxys19705
-Node: Threading macros23858
-Node: Modifying filled taxys24397
-Node: Dynamic taxys25215
-Node: Multi-level dynamic taxys27864
-Node: "Chains" of independent multi-level dynamic taxys30057
-Node: Defining a classification domain-specific language32988
-Node: Magit section37151
-Node: Reference37848
-Node: Functions37985
-Node: Macros39963
-Node: Changelog40613
-Node: 08-pre40827
-Node: 0740933
+Node: Examples2219
+Node: Numbery (starting basically)2538
+Node: Lettery (filling incrementally)8299
+Node: Sporty (understanding completely)10813
+Node: Applications16800
+Node: Installation17275
+Node: Usage17588
+Node: Reusable taxys19743
+Node: Threading macros23896
+Node: Modifying filled taxys24435
+Node: Dynamic taxys25253
+Node: Multi-level dynamic taxys27902
+Node: "Chains" of independent multi-level dynamic taxys30095
+Node: Defining a classification domain-specific language33026
+Node: Magit section37189
+Node: Reference37886
+Node: Functions38094
+Node: Macros40072
+Node: Changelog40722
+Node: 08-pre40936
Node: Additions41048
-Node: 0641363
-Node: Additions (1)41488
-Node: 0542838
-Node: Additions (2)42973
-Node: Fixes44079
-Node: 0444233
-Node: 0344455
-Node: Changes44584
-Node: Fixes (1)44947
-Node: 0245382
-Node: Changes (1)45551
-Node: Additions (3)45843
-Node: Fixes (2)46702
-Node: 0146956
-Node: Development47055
-Node: Copyright assignment47261
-Node: Credits47849
-Node: License48039
+Node: 0741182
+Node: Additions (1)41311
+Node: 0641630
+Node: Additions (2)41755
+Node: 0543105
+Node: Additions (3)43240
+Node: Fixes44346
+Node: 0444500
+Node: 0344722
+Node: Changes44851
+Node: Fixes (1)45214
+Node: 0245649
+Node: Changes (1)45818
+Node: Additions (4)46110
+Node: Fixes (2)46969
+Node: 0147223
+Node: Development47322
+Node: Copyright assignment47528
+Node: Credits48116
+Node: License48306
End Tag Table
