mirror of
https://git.notmuchmail.org/git/notmuch
synced 2024-11-21 18:38:08 +01:00
2ca941163d
`outline-minor-mode' treats comments that begin with three or more semicolons as headings. That makes it very convenient to navigate code and to show/hide parts of a file. Elips libraries typically have four top-level sections, e.g.: ;;; notmuch.el --- run notmuch within emacs... ;;; Commentary:... ;;; Code:... ;;; notmuch.el ends here In this package many libraries lack a "Commentary:" section, which is not optimal but okay for most libraries, except major entry points. Depending on how one chooses to look at it, the "... ends here" line is not really a heading that begins a section, because it should never have a "section" body (after all it marks eof). If the file is rather short, then I left "Code:" as the only section that contains code. Otherwise I split the file into multiple sibling sections. The "Code:" section continues to contain `require' and `declare-function' forms and other such "front matter". If and only if I have split the code into multiple sections anyway, then I also added an additional section named just "_" before the `provide' form and shortly before the "...end here" line. This section could also be called "Back matter", but I feel it would be distracting to be that explicit about it. (The IMO unnecessary but unfortunately still obligatory "... ends here" line is already distracting enough as far as I am concerned.) Before this commit some libraries already uses section headings, some of them consistently. When a library already had some headings, then this commit often sticks to that style, even at the cost inconsistent styling across all libraries. A very limited number of variable and function definitions have to be moved around because they would otherwise end up in sections they do not belong into. Sections, including but not limited to their heading, can and should be further improved in the future. |
||
|---|---|---|
| .. | ||
| .gitignore | ||
| coolj.el | ||
| make-deps.el | ||
| Makefile | ||
| Makefile.local | ||
| notmuch-address.el | ||
| notmuch-company.el | ||
| notmuch-compat.el | ||
| notmuch-crypto.el | ||
| notmuch-draft.el | ||
| notmuch-emacs-mua | ||
| notmuch-emacs-mua.desktop | ||
| notmuch-hello.el | ||
| notmuch-jump.el | ||
| notmuch-lib.el | ||
| notmuch-logo.png | ||
| notmuch-maildir-fcc.el | ||
| notmuch-message.el | ||
| notmuch-mua.el | ||
| notmuch-parser.el | ||
| notmuch-pkg.el.tmpl | ||
| notmuch-print.el | ||
| notmuch-query.el | ||
| notmuch-show.el | ||
| notmuch-tag.el | ||
| notmuch-tree.el | ||
| notmuch-version.el.tmpl | ||
| notmuch-wash.el | ||
| notmuch.el | ||
| rstdoc.el | ||
| rstdoc.rsti | ||
