diff options
author | Jonas Bernoulli <jonas@bernoul.li> | 2020-02-25 14:32:18 +0100 |
---|---|---|
committer | Jonas Bernoulli <jonas@bernoul.li> | 2020-03-27 21:38:45 +0100 |
commit | 3ceb31b71824e59e3f000edf7cb09ab86616d723 (patch) | |
tree | 25e32dd1cbb88878aaa4df3fe88b2f860cb0ebc7 /doc/img/autodoc-scm.png | |
parent | 715f4c0ee0f50b251679e55650cedcae3a246b57 (diff) | |
download | geiser-3ceb31b71824e59e3f000edf7cb09ab86616d723.tar.gz geiser-3ceb31b71824e59e3f000edf7cb09ab86616d723.tar.bz2 |
Mark the beginning of code part of elisp libraries with Code: heading
It's the convention and by following it we make a big step towards
supporting outline navigation.
The convention doesn't say much about what parts of the code are
supposed to be part of that sections and what parts belong in a
subsequent section. Here we put the `require' forms in this section
and maybe some setup code, that's a popular approach.
In most cases there was "" where we now insert "Code:". They both
serve a similar purpose and we keep the former because some users
depend on that for navigation. We even add this "" in libraries
where it previously was missing.
In some cases the permission statement was followed by a commentary,
which obviously does not belong in the "Code:" section. In such cases
add the conventional "Commentary:" section.
Diffstat (limited to 'doc/img/autodoc-scm.png')
0 files changed, 0 insertions, 0 deletions