summaryrefslogtreecommitdiff
path: root/devdocs/elisp/format-of-descriptions.html
diff options
context:
space:
mode:
authorCraig Jennings <c@cjennings.net>2024-04-07 13:41:34 -0500
committerCraig Jennings <c@cjennings.net>2024-04-07 13:41:34 -0500
commit754bbf7a25a8dda49b5d08ef0d0443bbf5af0e36 (patch)
treef1190704f78f04a2b0b4c977d20fe96a828377f1 /devdocs/elisp/format-of-descriptions.html
new repository
Diffstat (limited to 'devdocs/elisp/format-of-descriptions.html')
-rw-r--r--devdocs/elisp/format-of-descriptions.html16
1 files changed, 16 insertions, 0 deletions
diff --git a/devdocs/elisp/format-of-descriptions.html b/devdocs/elisp/format-of-descriptions.html
new file mode 100644
index 00000000..c851ffbb
--- /dev/null
+++ b/devdocs/elisp/format-of-descriptions.html
@@ -0,0 +1,16 @@
+ <h4 class="subsection">Format of Descriptions</h4> <p>Functions, variables, macros, commands, user options, and special forms are described in this manual in a uniform format. The first line of a description contains the name of the item followed by its arguments, if any. The category—function, variable, or whatever—appears at the beginning of the line. The description follows on succeeding lines, sometimes with examples. </p> <table class="menu" border="0" cellspacing="0"> <tr>
+<td align="left" valign="top">• <a href="a-sample-function-description" accesskey="1">A Sample Function Description</a>
+</td>
+<td> </td>
+<td align="left" valign="top">A description of an imaginary function, <code>foo</code>. </td>
+</tr> <tr>
+<td align="left" valign="top">• <a href="a-sample-variable-description" accesskey="2">A Sample Variable Description</a>
+</td>
+<td> </td>
+<td align="left" valign="top">A description of an imaginary variable, <code>electric-future-map</code>. </td>
+</tr> </table><div class="_attribution">
+ <p class="_attribution-p">
+ Copyright &copy; 1990-1996, 1998-2022 Free Software Foundation, Inc. <br>Licensed under the GNU GPL license.<br>
+ <a href="https://www.gnu.org/software/emacs/manual/html_node/elisp/Format-of-Descriptions.html" class="_attribution-link">https://www.gnu.org/software/emacs/manual/html_node/elisp/Format-of-Descriptions.html</a>
+ </p>
+</div>