Re: [comp.emacs.xemacs] Documenting elisp code

Jarl> I ment that the outline-mode _in use_ comply with the Jarl> library header tips. OK. Point for library headers. Jarl> But I guess what is wanted is documentation that is Jarl> consistent, and an outline-mode behaviour that comply with Jarl> that documentation. Yes. Jarl> Personally I prefer the elisp coding tips. I don't have a problem with that. But we should recommend something supported by the tools, and consistent with examples of "best practice." If you want to go through lisp-mnt.el and emacs-lisp-mode and so on, and add the possibility of switching (similar to the way various styles are permitted in cc-mode), I don't have an objection to that. But XEmacs core and XEmacs-maintained packages will continue to be done in the "library" style. We should document that as "recommended." Jarl> OK, so I guess you (to avoid recoding parts of lisp-mnt) Jarl> suggest the library header tips Not just lisp-mnt, but all of that "sample code" as well. Please revise the tips to emphasize the "library header" style. You are welcome to leave the description of the "elisp tips" as an alternative, but you should mention that it is (a) poorly (== not?) supported by the tools and (b) inconsistent with most code in XEmacs. -- Institute of Policy and Planning Sciences http://turnbull.sk.tsukuba.ac.jp University of Tsukuba Tennodai 1-1-1 Tsukuba 305-8573 JAPAN Don't ask how you can "do" free software business; ask what your business can "do for" free software.