From 82ba818ff456bcd6d56a06226e3f27e98fbb55c3 Mon Sep 17 00:00:00 2001 From: Craig Jennings Date: Thu, 14 Aug 2025 22:58:58 -0500 Subject: removing all downloaded devdocs files --- devdocs/elisp/documentation.html | 41 ---------------------------------------- 1 file changed, 41 deletions(-) delete mode 100644 devdocs/elisp/documentation.html (limited to 'devdocs/elisp/documentation.html') diff --git a/devdocs/elisp/documentation.html b/devdocs/elisp/documentation.html deleted file mode 100644 index 932416ea..00000000 --- a/devdocs/elisp/documentation.html +++ /dev/null @@ -1,41 +0,0 @@ -

Documentation

GNU Emacs has convenient built-in help facilities, most of which derive their information from documentation strings associated with functions and variables. This chapter describes how to access documentation strings in Lisp programs.

The contents of a documentation string should follow certain conventions. In particular, its first line should be a complete sentence (or two complete sentences) that briefly describes what the function or variable does. See Documentation Tips, for how to write good documentation strings.

Note that the documentation strings for Emacs are not the same thing as the Emacs manual. Manuals have their own source files, written in the Texinfo language; documentation strings are specified in the definitions of the functions and variables they apply to. A collection of documentation strings is not sufficient as a manual because a good manual is not organized in that fashion; it is organized in terms of topics of discussion.

For commands to display documentation strings, see Help in The GNU Emacs Manual.

- - - - - - - - - - - - - - - - - - - - - - - - - - - -
• Documentation Basics - Where doc strings are defined and stored.
• Accessing Documentation - How Lisp programs can access doc strings.
• Keys in Documentation - Substituting current key bindings.
• Text Quoting Style - Quotation marks in doc strings and messages.
• Describing Characters - Making printable descriptions of non-printing characters and key sequences.
• Help Functions - Subroutines used by Emacs help facilities.
• Documentation Groups - Listing functions by groups.
-

- Copyright © 1990-1996, 1998-2022 Free Software Foundation, Inc.
Licensed under the GNU GPL license.
- https://www.gnu.org/software/emacs/manual/html_node/elisp/Documentation.html -

-
-- cgit v1.2.3