[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[elpa] externals/taxy 7202ec4 1/3: Docs: Adjust formatting
|
From: |
ELPA Syncer |
|
Subject: |
[elpa] externals/taxy 7202ec4 1/3: Docs: Adjust formatting |
|
Date: |
Fri, 17 Sep 2021 17:57:21 -0400 (EDT) |
branch: externals/taxy
commit 7202ec4107063960c9b5339fec54f17f705ddbc7
Author: Adam Porter <adam@alphapapa.net>
Commit: Adam Porter <adam@alphapapa.net>
Docs: Adjust formatting
---
README.org | 63 +++++++++++++++++++++-----------------------------
taxy.info | 77 +++++++++++++++++++++++++++-----------------------------------
2 files changed, 59 insertions(+), 81 deletions(-)
diff --git a/README.org b/README.org
index 73033bc..652524f 100644
--- a/README.org
+++ b/README.org
@@ -883,59 +883,48 @@ Note that while =taxy-magit-section.el= is installed with
the =taxy= package, th
*** Functions
-**** taxy-flatten (taxy)
+- taxy-flatten (taxy) ::
+ Return a list of items in =taxy= and its sub-taxys.
-Return a list of items in =taxy= and its sub-taxys.
+- taxy-emptied (taxy) ::
+ Return a copy of =taxy= without items. Omits =taxy=’s items and those of
its descendant taxys. Useful when reusing taxy definitions.
-**** taxy-emptied (taxy)
+- taxy-fill (items taxy) ::
+ Fill =taxy= with =items= according to its definition.
-Return a copy of =taxy= without items. Omits =taxy=’s items and those of its
descendant taxys. Useful when reusing taxy definitions.
+- taxy-make-take-function (keys aliases) ::
+ Return a taxy "take" function for =keys=. Each of =keys= should be a
function alias defined in =aliases=, or a list of such =key-fns= (recursively,
ad infinitum, approximately). =aliases= should be an alist mapping aliases to
functions (such as defined with a definer defined by ~taxy-define-key-definer~).
-**** taxy-fill (items taxy)
+- taxy-mapc-taxys (fn taxy) ::
+ *Alias:* ~taxy-mapc*~
-Fill =taxy= with =items= according to its definition.
+ Return =taxy= having applied =fn= to it and its descendants. Does not copy
=taxy=. Destructively modifies =taxy=, if =fn= does.
-**** taxy-make-take-function (keys aliases)
+- taxy-mapcar-items (fn taxy) ::
+ *Alias:* ~taxy-mapcar~
-Return a taxy "take" function for =keys=. Each of =keys= should be a function
alias defined in =aliases=, or a list of such =key-fns= (recursively, ad
infinitum, approximately). =aliases= should be an alist mapping aliases to
functions (such as defined with a definer defined by ~taxy-define-key-definer~).
+ Return copy of =taxy=, having replaced its items with the value of =fn= on
each. Replaces every item in =taxy= and its descendants. Useful to replace
items with a more useful form after classification.
-**** taxy-mapc-taxys (fn taxy)
+- taxy-plain (taxy) ::
+ Return a list of the human-readable parts of =taxy=.
-*Alias:* ~taxy-mapc*~
+- taxy-size (taxy) ::
+ Return the number of items =taxy= holds. Includes items in =taxy= ’s
sub-taxys.
-Return =taxy= having applied =fn= to it and its descendants. Does not copy
=taxy=. Destructively modifies =taxy=, if =fn= does.
+- taxy-sort-items (pred key taxy) ::
+ *Alias:* ~taxy-sort~
-**** taxy-mapcar-items (fn taxy)
+ Sort =taxy= ’s items by =pred= and =key=. Sorts items in =taxy= and its
sub-taxys. =key= is passed to ~cl-sort~, which see.
-*Alias:* ~taxy-mapcar~
+- taxy-sort-taxys (pred key taxy) ::
+ *Alias:* ~taxy-sort*~
-Return copy of =taxy=, having replaced its items with the value of =fn= on
each. Replaces every item in =taxy= and its descendants. Useful to replace
items with a more useful form after classification.
-
-**** taxy-plain (taxy)
-
-Return a list of the human-readable parts of =taxy=.
-
-**** taxy-size (taxy)
-
-Return the number of items =taxy= holds. Includes items in =taxy= ’s
sub-taxys.
-
-**** taxy-sort-items (pred key taxy)
-
-*Alias:* ~taxy-sort~
-
-Sort =taxy= ’s items by =pred= and =key=. Sorts items in =taxy= and its
sub-taxys. =key= is passed to ~cl-sort~, which see.
-
-**** taxy-sort-taxys (pred key taxy)
-
-*Alias:* ~taxy-sort*~
-
-Sort =taxy= ’s sub-taxys by =pred= and =key=. =key= is passed to ~cl-sort~,
which see.
+ Sort =taxy= ’s sub-taxys by =pred= and =key=. =key= is passed to ~cl-sort~,
which see.
*** Macros
-**** taxy-define-key-definer (name variable prefix docstring)
-
-Define a macro =name= that defines a key-function-defining macro. The defined
macro, having string =docstring=, associates the defined key functions with
their aliases in an alist stored in symbol =variable=. The defined key
functions are named having string =prefix=, which will have a hyphen appended
to it. The key functions take one or more arguments, the first of which is the
item being tested, bound within the function to ~item~.
+- taxy-define-key-definer (name variable prefix docstring) ::
+ Define a macro =name= that defines a key-function-defining macro. The
defined macro, having string =docstring=, associates the defined key functions
with their aliases in an alist stored in symbol =variable=. The defined key
functions are named having string =prefix=, which will have a hyphen appended
to it. The key functions take one or more arguments, the first of which is the
item being tested, bound within the function to ~item~.
* Changelog
:PROPERTIES:
diff --git a/taxy.info b/taxy.info
index 4e61e05..2a1714f 100644
--- a/taxy.info
+++ b/taxy.info
@@ -1048,37 +1048,31 @@ File: README.info, Node: Functions, Next: Macros,
Up: Reference
3.6.1 Functions
---------------
- 1. taxy-flatten (taxy)
-
+taxy-flatten (taxy)
Return a list of items in ‘taxy’ and its sub-taxys.
- 2. taxy-emptied (taxy)
-
+taxy-emptied (taxy)
Return a copy of ‘taxy’ without items. Omits =taxy=’s items and
those of its descendant taxys. Useful when reusing taxy
definitions.
- 3. taxy-fill (items taxy)
-
+taxy-fill (items taxy)
Fill ‘taxy’ with ‘items’ according to its definition.
- 4. taxy-make-take-function (keys aliases)
-
+taxy-make-take-function (keys aliases)
Return a taxy "take" function for ‘keys’. Each of ‘keys’ should be
a function alias defined in ‘aliases’, or a list of such ‘key-fns’
(recursively, ad infinitum, approximately). ‘aliases’ should be an
alist mapping aliases to functions (such as defined with a definer
defined by ‘taxy-define-key-definer’).
- 5. taxy-mapc-taxys (fn taxy)
-
+taxy-mapc-taxys (fn taxy)
*Alias:* ‘taxy-mapc*’
Return ‘taxy’ having applied ‘fn’ to it and its descendants. Does
not copy ‘taxy’. Destructively modifies ‘taxy’, if ‘fn’ does.
- 6. taxy-mapcar-items (fn taxy)
-
+taxy-mapcar-items (fn taxy)
*Alias:* ‘taxy-mapcar’
Return copy of ‘taxy’, having replaced its items with the value of
@@ -1086,24 +1080,20 @@ File: README.info, Node: Functions, Next: Macros,
Up: Reference
Useful to replace items with a more useful form after
classification.
- 7. taxy-plain (taxy)
-
+taxy-plain (taxy)
Return a list of the human-readable parts of ‘taxy’.
- 8. taxy-size (taxy)
-
+taxy-size (taxy)
Return the number of items ‘taxy’ holds. Includes items in ‘taxy’
’s sub-taxys.
- 9. taxy-sort-items (pred key taxy)
-
+taxy-sort-items (pred key taxy)
*Alias:* ‘taxy-sort’
Sort ‘taxy’ ’s items by ‘pred’ and ‘key’. Sorts items in ‘taxy’
and its sub-taxys. ‘key’ is passed to ‘cl-sort’, which see.
- 10. taxy-sort-taxys (pred key taxy)
-
+taxy-sort-taxys (pred key taxy)
*Alias:* ‘taxy-sort*’
Sort ‘taxy’ ’s sub-taxys by ‘pred’ and ‘key’. ‘key’ is passed to
@@ -1115,8 +1105,7 @@ File: README.info, Node: Macros, Prev: Functions, Up:
Reference
3.6.2 Macros
------------
- 1. taxy-define-key-definer (name variable prefix docstring)
-
+taxy-define-key-definer (name variable prefix docstring)
Define a macro ‘name’ that defines a key-function-defining macro.
The defined macro, having string ‘docstring’, associates the
defined key functions with their aliases in an alist stored in
@@ -1409,28 +1398,28 @@ Node: Defining a classification domain-specific
language32981
Node: Magit section37144
Node: Reference37841
Node: Functions37978
-Node: Macros40017
-Node: Changelog40673
-Node: 07-pre40876
-Node: Additions40988
-Node: 0641307
-Node: Additions (1)41436
-Node: 0542786
-Node: Additions (2)42921
-Node: Fixes44027
-Node: 0444181
-Node: 0344403
-Node: Changes44532
-Node: Fixes (1)44895
-Node: 0245330
-Node: Changes (1)45499
-Node: Additions (3)45791
-Node: Fixes (2)46650
-Node: 0146904
-Node: Development47003
-Node: Copyright assignment47209
-Node: Credits47797
-Node: License47987
+Node: Macros39956
+Node: Changelog40606
+Node: 07-pre40809
+Node: Additions40921
+Node: 0641240
+Node: Additions (1)41369
+Node: 0542719
+Node: Additions (2)42854
+Node: Fixes43960
+Node: 0444114
+Node: 0344336
+Node: Changes44465
+Node: Fixes (1)44828
+Node: 0245263
+Node: Changes (1)45432
+Node: Additions (3)45724
+Node: Fixes (2)46583
+Node: 0146837
+Node: Development46936
+Node: Copyright assignment47142
+Node: Credits47730
+Node: License47920
End Tag Table