From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!not-for-mail From: MON KEY Newsgroups: gmane.emacs.bugs Subject: bug#6486: documentation of `byte-code-function-p' should mention `symbol-function' and xref manual Date: Mon, 21 Jun 2010 13:36:22 -0400 Message-ID: NNTP-Posting-Host: lo.gmane.org Mime-Version: 1.0 Content-Type: text/plain; charset=UTF-8 X-Trace: dough.gmane.org 1277143149 32632 80.91.229.12 (21 Jun 2010 17:59:09 GMT) X-Complaints-To: usenet@dough.gmane.org NNTP-Posting-Date: Mon, 21 Jun 2010 17:59:09 +0000 (UTC) To: 6486@debbugs.gnu.org Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane.org@gnu.org Mon Jun 21 19:59:07 2010 Return-path: Envelope-to: geb-bug-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 1OQlH0-00019M-9L for geb-bug-gnu-emacs@m.gmane.org; Mon, 21 Jun 2010 19:59:07 +0200 Original-Received: from localhost ([127.0.0.1]:50570 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.43) id 1OQlGy-0002hc-L7 for geb-bug-gnu-emacs@m.gmane.org; Mon, 21 Jun 2010 13:59:04 -0400 Original-Received: from [140.186.70.92] (port=39151 helo=eggs.gnu.org) by lists.gnu.org with esmtp (Exim 4.43) id 1OQlGr-0002gH-KI for bug-gnu-emacs@gnu.org; Mon, 21 Jun 2010 13:58:58 -0400 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.69) (envelope-from ) id 1OQlGp-0004wk-MS for bug-gnu-emacs@gnu.org; Mon, 21 Jun 2010 13:58:57 -0400 Original-Received: from debbugs.gnu.org ([140.186.70.43]:58646) by eggs.gnu.org with esmtp (Exim 4.69) (envelope-from ) id 1OQlGp-0004wg-L7 for bug-gnu-emacs@gnu.org; Mon, 21 Jun 2010 13:58:55 -0400 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.69) (envelope-from ) id 1OQkvd-0005za-N9; Mon, 21 Jun 2010 13:37:01 -0400 X-Loop: help-debbugs@gnu.org Resent-From: MON KEY Original-Sender: debbugs-submit-bounces@debbugs.gnu.org Resent-To: owner@debbugs.gnu.org Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Mon, 21 Jun 2010 17:37:01 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: report 6486 X-GNU-PR-Package: emacs X-GNU-PR-Keywords: X-Debbugs-Original-To: bug-gnu-emacs@gnu.org Original-Received: via spool by submit@debbugs.gnu.org id=B.127714179523026 (code B ref -1); Mon, 21 Jun 2010 17:37:01 +0000 Original-Received: (at submit) by debbugs.gnu.org; 21 Jun 2010 17:36:35 +0000 Original-Received: from localhost ([127.0.0.1] helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.69) (envelope-from ) id 1OQkvC-0005zL-OM for submit@debbugs.gnu.org; Mon, 21 Jun 2010 13:36:35 -0400 Original-Received: from mail.gnu.org ([199.232.76.166] helo=mx10.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.69) (envelope-from ) id 1OQkvA-0005zE-M2 for submit@debbugs.gnu.org; Mon, 21 Jun 2010 13:36:32 -0400 Original-Received: from lists.gnu.org ([199.232.76.165]:37235) by monty-python.gnu.org with esmtps (TLS-1.0:DHE_RSA_AES_256_CBC_SHA1:32) (Exim 4.60) (envelope-from ) id 1OQkv6-0005qJ-2t for submit@debbugs.gnu.org; Mon, 21 Jun 2010 13:36:28 -0400 Original-Received: from [140.186.70.92] (port=59005 helo=eggs.gnu.org) by lists.gnu.org with esmtp (Exim 4.43) id 1OQkv4-0003Rg-JK for bug-gnu-emacs@gnu.org; Mon, 21 Jun 2010 13:36:27 -0400 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.69) (envelope-from ) id 1OQkv3-0001qV-7s for bug-gnu-emacs@gnu.org; Mon, 21 Jun 2010 13:36:26 -0400 Original-Received: from mail-yx0-f169.google.com ([209.85.213.169]:34902) by eggs.gnu.org with esmtp (Exim 4.69) (envelope-from ) id 1OQkv3-0001qJ-5j for bug-gnu-emacs@gnu.org; Mon, 21 Jun 2010 13:36:25 -0400 Original-Received: by yxd39 with SMTP id 39so196418yxd.0 for ; Mon, 21 Jun 2010 10:36:23 -0700 (PDT) Original-Received: by 10.150.150.10 with SMTP id x10mr4665484ybd.176.1277141782922; Mon, 21 Jun 2010 10:36:22 -0700 (PDT) Original-Received: by 10.151.10.5 with HTTP; Mon, 21 Jun 2010 10:36:22 -0700 (PDT) X-Google-Sender-Auth: LVF1Z_SIPg75ESg2kldM9fjzwdg X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.6 (newer, 2) X-detected-operating-system: by monty-python.gnu.org: GNU/Linux 2.6, seldom 2.4 (older, 4) X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.11 Precedence: list Resent-Date: Mon, 21 Jun 2010 13:37:01 -0400 X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.6 (newer, 3) X-BeenThere: bug-gnu-emacs@gnu.org List-Id: "Bug reports for GNU Emacs, the Swiss army knife of text editors" List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Original-Sender: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane.org@gnu.org Errors-To: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane.org@gnu.org Xref: news.gmane.org gmane.emacs.bugs:37932 Archived-At: The documentation of function `byte-code-function-p' should mention usage requires `symbol-function', and/or should refer to a relevant portion of the manual. ,---- (documentation 'byte-code-function-p) | | Return t if OBJECT is a byte-compiled function object. | | (fn OBJECT) | `---- The above docs do not adequately indicate that the OBJECT arg is as per the return value of `symbol-function'. e.g.: (byte-code-function-p 'disassemble) ;=> nil (byte-code-function-p (symbol-function 'disassemble)) ;=> t How is the user supposed to know that OBJECT will only return t if it is the unreadable vector returned by `symbol-function'? Please add documentation of such, along with info node xref such as: See info node `(elisp) Byte-Code Objects' Also, note that the nature of the data-structure/readability of a byte-code'd function can not be deduced by the user by simply reading the manual section: (info "(elisp)What Is a Function") -- /s_P\