From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!not-for-mail From: Ralf Mattes Newsgroups: gmane.emacs.help Subject: Re: Wrong "Not documented" message, bug? Date: Thu, 14 Oct 2010 13:08:30 +0000 (UTC) Message-ID: References: <4CB6BDA7.7040204@easy-emacs.de> NNTP-Posting-Host: lo.gmane.org Mime-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit X-Trace: dough.gmane.org 1287061789 14794 80.91.229.12 (14 Oct 2010 13:09:49 GMT) X-Complaints-To: usenet@dough.gmane.org NNTP-Posting-Date: Thu, 14 Oct 2010 13:09:49 +0000 (UTC) To: help-gnu-emacs@gnu.org Original-X-From: help-gnu-emacs-bounces+geh-help-gnu-emacs=m.gmane.org@gnu.org Thu Oct 14 15:09:47 2010 Return-path: Envelope-to: geh-help-gnu-emacs@m.gmane.org Original-Received: from lists.gnu.org ([199.232.76.165]) by lo.gmane.org with esmtp (Exim 4.69) (envelope-from ) id 1P6NZ5-0006DB-Gd for geh-help-gnu-emacs@m.gmane.org; Thu, 14 Oct 2010 15:09:47 +0200 Original-Received: from localhost ([127.0.0.1]:50879 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.43) id 1P6NZ4-0003T6-O1 for geh-help-gnu-emacs@m.gmane.org; Thu, 14 Oct 2010 09:09:46 -0400 Original-Received: from [140.186.70.92] (port=40163 helo=eggs.gnu.org) by lists.gnu.org with esmtp (Exim 4.43) id 1P6NY1-0003Qv-Jc for help-gnu-emacs@gnu.org; Thu, 14 Oct 2010 09:08:42 -0400 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1P6NY0-0003nD-AH for help-gnu-emacs@gnu.org; Thu, 14 Oct 2010 09:08:41 -0400 Original-Received: from lo.gmane.org ([80.91.229.12]:44208) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1P6NY0-0003n4-4j for help-gnu-emacs@gnu.org; Thu, 14 Oct 2010 09:08:40 -0400 Original-Received: from list by lo.gmane.org with local (Exim 4.69) (envelope-from ) id 1P6NXy-0005bt-Oa for help-gnu-emacs@gnu.org; Thu, 14 Oct 2010 15:08:38 +0200 Original-Received: from i59f7a3e5.versanet.de ([89.247.163.229]) by main.gmane.org with esmtp (Gmexim 0.1 (Debian)) id 1AlnuQ-0007hv-00 for ; Thu, 14 Oct 2010 15:08:38 +0200 Original-Received: from rm by i59f7a3e5.versanet.de with local (Gmexim 0.1 (Debian)) id 1AlnuQ-0007hv-00 for ; Thu, 14 Oct 2010 15:08:38 +0200 X-Injected-Via-Gmane: http://gmane.org/ Original-Lines: 57 Original-X-Complaints-To: usenet@dough.gmane.org X-Gmane-NNTP-Posting-Host: i59f7a3e5.versanet.de User-Agent: Pan/0.132 (Waxed in Black) X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.6 (newer, 3) X-BeenThere: help-gnu-emacs@gnu.org X-Mailman-Version: 2.1.5 Precedence: list List-Id: Users list for the GNU Emacs text editor List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Original-Sender: help-gnu-emacs-bounces+geh-help-gnu-emacs=m.gmane.org@gnu.org Errors-To: help-gnu-emacs-bounces+geh-help-gnu-emacs=m.gmane.org@gnu.org Xref: news.gmane.org gmane.emacs.help:75118 Archived-At: On Thu, 14 Oct 2010 10:21:59 +0200, Andreas Röhler wrote: > Hi, > > M-x describe-function `py-in-string/comment' points me to the code > below, which is correct: > > > (defun py-in-string/comment () > (interactive) > "Returns character address of start of comment or string; nil if not > in one. " > (lexical-let ((erg (nth 8 (syntax-ppss)))) > (unless erg (when (or (looking-at "\"\"\"") > (looking-at (concat "^[ \t]*" > comment-start-skip))) > (setq erg (point)))) > (when (interactive-p) (message "%s" erg)) erg)) > > However, it says: > > ,---- > | py-in-string/comment is an interactive Lisp function in | > `python-components-intern.el'. > | > | (py-in-string/comment) > | > | Not documented. > `---- > > Something odd with doku here? A bug? How about adding a docstring? :-) Something like: (defun py-in-string/comment () "Returns character address of start of comment or string; nil if not in one. " .... HTH Ralf Mattes > Thanks > > > Andreas > > -- > https://code.launchpad.net/~a-roehler/python-mode/python-mode-components > https://code.launchpad.net/s-x-emacs-werkstatt/ > > > PS: If interested, see the complete files contents at > > http://bazaar.launchpad.net/~a-roehler/python-mode/python-mode- components/annotate/head%3A/python-components-intern.el