1
Fork 0
mirror of git://git.sv.gnu.org/emacs.git synced 2026-03-14 10:51:20 -07:00
emacs/doc/lispref
Jonas Bernoulli 838a1a313c Update section heading conventions for libraries
* doc/lispref/tips.texi (Comment Tips): Update information on section
  headings to reflect common usage.

Previously the tips stated that if the code is split up into multiple
sections, then that should be done by splitting up the ";;; Code:"
section into multiple sub-sections.

However about half the libraries in Emacs instead use multiple
top-level sections.  We update the tips (aka conventions) to allow
this common usage, but because it is awkward if there is a section
named "Code", which contains only some of the code instead of all of
it, we now recommend that that section should be empty in this case.

We cannot just give up on the "Code:" section/heading because that is
an old convention that is followed be nearly every library and because
it is likely that there are some utilities out there that depend on
its presence.

This was discussed in
https://lists.gnu.org/archive/html/emacs-devel/2020-07/msg00444.html
https://lists.gnu.org/archive/html/emacs-devel/2020-08/msg00001.html
2020-08-13 11:34:49 +02:00
..
abbrevs.texi Remove #' and function quoting from lambda forms in manual 2020-04-19 13:19:37 +02:00
anti.texi
back.texi
backups.texi Remove #' and function quoting from lambda forms in manual 2020-04-19 13:19:37 +02:00
book-spine.texi
buffers.texi
ChangeLog.1
commands.texi
compile.texi Document that 'byte-compile-dynamic' is obsolete 2020-03-07 14:23:23 +02:00
control.texi Don't use 'cl' functions in ELisp manual's examples 2020-06-20 10:29:37 +03:00
customize.texi Fix typo in "(elisp) Type Keywords" 2020-06-07 16:46:12 +01:00
debugging.texi Fix some Texinfo markup 2020-06-17 13:07:51 +01:00
display.texi Document that :width/:height in XBM images are peculiar 2020-08-02 19:03:21 +02:00
doclicense.texi
edebug.texi Avoid duplicate Edebug symbols when using ‘cl-flet’ (Bug#41989) 2020-08-02 17:39:24 +02:00
elisp.texi Don’t use “constant” for values you shouldn’t change 2020-05-16 18:24:07 -07:00
errors.texi Clean up D-Bus documentation (bug#41744) 2020-06-08 18:19:50 +01:00
eval.texi Don’t use “constant” for values you shouldn’t change 2020-05-16 18:24:07 -07:00
files.texi Merge from origin/emacs-27 2020-06-17 08:47:53 -07:00
frames.texi Merge from origin/emacs-27 2020-07-07 07:50:40 -07:00
functions.texi Remove #' and function quoting from lambda forms in manual 2020-04-19 13:19:37 +02:00
gpl.texi
hash.texi
help.texi Remove #' and function quoting from lambda forms in manual 2020-04-19 13:19:37 +02:00
hooks.texi
index.texi
internals.texi ; * doc/lispref/internals.texi (Module Misc): Fix version 2020-03-29 10:22:35 +02:00
intro.texi
keymaps.texi Merge from origin/emacs-27 2020-04-20 07:50:19 -07:00
lay-flat.texi
lists.texi Don’t use “constant” for values you shouldn’t change 2020-05-16 18:24:07 -07:00
loading.texi Merge from origin/emacs-27 2020-05-28 07:50:26 -07:00
macros.texi
Makefile.in
maps.texi
markers.texi
minibuf.texi Merge from origin/emacs-27 2020-03-07 07:50:28 -08:00
modes.texi Consistently stylize eldoc as ElDoc in more prose 2020-07-14 13:49:34 +01:00
nonascii.texi Revert markup change in with-coding-priority docs 2020-06-13 17:54:51 +01:00
numbers.texi Mention floating rounding issues 2020-07-09 08:40:58 -07:00
objects.texi Merge from origin/emacs-27 2020-05-23 07:50:29 -07:00
os.texi Modernise a code example in os.texi 2020-08-08 15:17:38 +02:00
package.texi
positions.texi Allow count-lines to ignore invisible lines 2020-08-11 16:52:11 +02:00
processes.texi Allow open-network-stream to use different TLS capability commands 2020-07-19 02:56:40 +02:00
README
records.texi
searching.texi Regexps cannot infloop; fix manual 2020-05-03 14:27:51 +02:00
sequences.texi Don’t use “constant” for values you shouldn’t change 2020-05-16 18:24:07 -07:00
spellfile
streams.texi
strings.texi Correct 'concat' manual entry (bug#42296) 2020-07-11 15:15:24 +02:00
symbols.texi * doc/lispref/symbols.texi (Definitions): Fix typo. 2020-07-29 12:35:19 +02:00
syntax.texi Remove #' and function quoting from lambda forms in manual 2020-04-19 13:19:37 +02:00
text.texi Use getrandom syscall for nonces 2020-06-27 13:03:49 -07:00
threads.texi
tips.texi Update section heading conventions for libraries 2020-08-13 11:34:49 +02:00
two-volume-cross-refs.txt
two-volume.make
variables.texi Document changes in lexical-binding 2020-03-07 13:32:52 +02:00
windows.texi Merge from origin/emacs-27 2020-04-15 07:50:15 -07:00

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

Copyright (C) 2001-2020 Free Software Foundation, Inc.  -*- outline -*-
See the end of the file for license conditions.


README for the Emacs Lisp Reference Manual.

* This directory contains the texinfo source files for the Emacs Lisp
Reference Manual.

* Report bugs in the Lisp Manual (or in Emacs) using M-x report-emacs-bug.
To ask questions, use the help-gnu-emacs mailing list.

* The Emacs Lisp Reference Manual is quite large.  It totals around
1100 pages in smallbook format; the info files total around 3.0 megabytes.

* You can format this manual for Info, for printing hardcopy using TeX,
or for HTML.

* You can buy nicely printed copies from the Free Software Foundation.
Buying a manual from the Free Software Foundation helps support our GNU
development work.  See <https://shop.fsf.org/>.
(At time of writing, this manual is out of print.)

* The master file for formatting this manual for Tex is called 'elisp.texi'.
It contains @include commands to include all the chapters that make up
the manual.

* This distribution contains a Makefile that you can use with GNU Make.

** To make an Info file, you need to install Texinfo, then run 'make info'.

** Use 'make elisp.pdf' or 'make elisp.html' to create PDF or HTML versions.


This file is part of GNU Emacs.

GNU Emacs is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

GNU Emacs is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with GNU Emacs.  If not, see <https://www.gnu.org/licenses/>.