From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!not-for-mail From: Emanuel Berg Newsgroups: gmane.emacs.help Subject: Re: describe-mode "some-mode"? Date: Sun, 24 Aug 2014 04:22:55 +0200 Organization: Aioe.org NNTP Server Message-ID: <87y4ueiq2o.fsf@debian.uxu> References: <87bnrc1lkz.fsf@yun.yagibdah.de> <988b6e41-62ed-4d33-abf1-804ddcedef59@default> NNTP-Posting-Host: plane.gmane.org Mime-Version: 1.0 Content-Type: text/plain X-Trace: ger.gmane.org 1408847127 25558 80.91.229.3 (24 Aug 2014 02:25:27 GMT) X-Complaints-To: usenet@ger.gmane.org NNTP-Posting-Date: Sun, 24 Aug 2014 02:25:27 +0000 (UTC) To: help-gnu-emacs@gnu.org Original-X-From: help-gnu-emacs-bounces+geh-help-gnu-emacs=m.gmane.org@gnu.org Sun Aug 24 04:25:19 2014 Return-path: Envelope-to: geh-help-gnu-emacs@m.gmane.org Original-Received: from lists.gnu.org ([208.118.235.17]) by plane.gmane.org with esmtp (Exim 4.69) (envelope-from ) id 1XLNUd-0002V3-16 for geh-help-gnu-emacs@m.gmane.org; Sun, 24 Aug 2014 04:25:19 +0200 Original-Received: from localhost ([::1]:42795 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1XLNUc-0006Jb-JN for geh-help-gnu-emacs@m.gmane.org; Sat, 23 Aug 2014 22:25:18 -0400 Original-Path: usenet.stanford.edu!news.kjsl.com!feeder.erje.net!eu.feeder.erje.net!newsfeed.fsmpi.rwth-aachen.de!eternal-september.org!feeder.eternal-september.org!aioe.org!.POSTED!not-for-mail Original-Newsgroups: gnu.emacs.help Original-Lines: 40 Original-NNTP-Posting-Host: P0uMB9BthHuWo8+BJXB4Mw.user.speranza.aioe.org Original-X-Complaints-To: abuse@aioe.org User-Agent: Gnus/5.13 (Gnus v5.13) Emacs/24.3 (gnu/linux) X-Notice: Filtered by postfilter v. 0.8.2 Cancel-Lock: sha1:LsV8FTfUVNv649B+cOgnwDEsFkE= Mail-Copies-To: never Original-Xref: usenet.stanford.edu gnu.emacs.help:207103 X-BeenThere: help-gnu-emacs@gnu.org X-Mailman-Version: 2.1.14 Precedence: list List-Id: Users list for the GNU Emacs text editor List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: help-gnu-emacs-bounces+geh-help-gnu-emacs=m.gmane.org@gnu.org Original-Sender: help-gnu-emacs-bounces+geh-help-gnu-emacs=m.gmane.org@gnu.org Xref: news.gmane.org gmane.emacs.help:99380 Archived-At: lee writes: > Emacs is self-documenting :) Emacs has a very clever help system that automatically incorporates the interfaces as you add functions (etc.). And, the help system has clever ways of hyperlinking and accounting for the configurationism of Emacs users, e.g., you don't "hard-document" actual keys in docstrings, but the correct keys (for the particular user, that may have his own keys) turn up just the same. And more. And the documentation comes with Emacs. Yes. But Emacs is still not exactly self-documenting, I wouldn't say. Here is an example of a creative docstring: hyperlinked (to wrap-search); keys (universal-argument will turn up C-u for most); and, the PREFIX will turn up in the face help-argument-name. (defun wrap-search-again (prefix) "Search again for the most recent search string of `wrap-search'. Use \\[universal-argument] \(to set the PREFIX\) to toggle case sensitiveness." ; ... ) You can use the below defun to check your docstrings. It is intended to check the code of packages, but you can use it to check docstrings and just ignore what it says that is package-related (if you are not coding a package, of course). (defun check-pack-style () (interactive) (checkdoc-current-buffer t) ) ; TAKE-NOTES (report all errors) -- underground experts united