diff options
Diffstat (limited to 'doc/lispref/help.texi')
| -rw-r--r-- | doc/lispref/help.texi | 9 |
1 files changed, 6 insertions, 3 deletions
diff --git a/doc/lispref/help.texi b/doc/lispref/help.texi index 3261cf838f7..a9bc9221912 100644 --- a/doc/lispref/help.texi +++ b/doc/lispref/help.texi | |||
| @@ -828,14 +828,16 @@ if the user types the help character again. | |||
| 828 | @cindex documentation groups | 828 | @cindex documentation groups |
| 829 | @cindex groups of functions | 829 | @cindex groups of functions |
| 830 | @cindex function groups | 830 | @cindex function groups |
| 831 | @cindex shortdoc groups | ||
| 831 | 832 | ||
| 832 | Emacs can list functions based on various groupings. For instance, | 833 | Emacs can list functions based on various groupings. For instance, |
| 833 | @code{string-trim} and @code{mapconcat} are ``string'' functions, so | 834 | @code{string-trim} and @code{mapconcat} are ``string'' functions, so |
| 834 | @kbd{M-x shortdoc RET string RET} will give an overview | 835 | @kbd{M-x shortdoc RET string RET} will give an overview of these and |
| 835 | of functions that operate on strings. | 836 | other functions that operate on strings. |
| 836 | 837 | ||
| 837 | The documentation groups are created with the | 838 | The documentation groups are created with the |
| 838 | @code{define-short-documentation-group} macro. | 839 | @code{define-short-documentation-group} macro. @xref{Documentation |
| 840 | Group Tips}, for how to write good documentation groups. | ||
| 839 | 841 | ||
| 840 | @defmac define-short-documentation-group group &rest functions | 842 | @defmac define-short-documentation-group group &rest functions |
| 841 | Define @var{group} as a group of functions, and provide short | 843 | Define @var{group} as a group of functions, and provide short |
| @@ -846,6 +848,7 @@ summaries of using those functions. The optional argument | |||
| 846 | (@var{func} [@var{keyword} @var{val}]@dots{}) | 848 | (@var{func} [@var{keyword} @var{val}]@dots{}) |
| 847 | @end lisp | 849 | @end lisp |
| 848 | 850 | ||
| 851 | @cindex documentation group keywords | ||
| 849 | The following keywords are recognized: | 852 | The following keywords are recognized: |
| 850 | 853 | ||
| 851 | @table @code | 854 | @table @code |