summaryrefslogtreecommitdiff
path: root/lisp/emacs-lisp/pcase.el
diff options
context:
space:
mode:
authorJonas Bernoulli <jonas@bernoul.li>2020-08-09 23:02:34 +0200
committerJonas Bernoulli <jonas@bernoul.li>2020-08-13 11:34:49 +0200
commit838a1a313caf9695a518c69b553abc1389b22495 (patch)
tree68fd4a6f80fbac3b2d5ef6a098caa3c5a21250a1 /lisp/emacs-lisp/pcase.el
parent7cb029d4d32b0f43c37e6129420db8ea8ed5e900 (diff)
downloademacs-838a1a313caf9695a518c69b553abc1389b22495.tar.gz
emacs-838a1a313caf9695a518c69b553abc1389b22495.tar.bz2
emacs-838a1a313caf9695a518c69b553abc1389b22495.zip
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
Diffstat (limited to 'lisp/emacs-lisp/pcase.el')
0 files changed, 0 insertions, 0 deletions