From unknown Sun Jun 22 03:58:24 2025 X-Loop: help-debbugs@gnu.org Subject: bug#9259: extra line in "unless" docstring? Resent-From: jidanni@jidanni.org Original-Sender: debbugs-submit-bounces@debbugs.gnu.org Resent-To: owner@debbugs.gnu.org Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Mon, 08 Aug 2011 04:58:01 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: report 9259 X-GNU-PR-Package: emacs X-GNU-PR-Keywords: To: 9259@debbugs.gnu.org X-Debbugs-Original-To: bug-gnu-emacs@gnu.org Received: via spool by submit@debbugs.gnu.org id=B.131277946922750 (code B ref -1); Mon, 08 Aug 2011 04:58:01 +0000 Received: (at submit) by debbugs.gnu.org; 8 Aug 2011 04:57:49 +0000 Received: from localhost ([127.0.0.1] helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.69) (envelope-from ) id 1QqHuO-0005ut-TC for submit@debbugs.gnu.org; Mon, 08 Aug 2011 00:57:49 -0400 Received: from eggs.gnu.org ([140.186.70.92]) by debbugs.gnu.org with esmtp (Exim 4.69) (envelope-from ) id 1QqHuM-0005uk-JN for submit@debbugs.gnu.org; Mon, 08 Aug 2011 00:57:47 -0400 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1QqHtN-0002GL-Cf for submit@debbugs.gnu.org; Mon, 08 Aug 2011 00:56:46 -0400 X-Spam-Checker-Version: SpamAssassin 3.3.1 (2010-03-16) on eggs.gnu.org X-Spam-Level: X-Spam-Status: No, score=-1.9 required=5.0 tests=BAYES_00, RCVD_IN_DNSWL_NONE, T_DKIM_INVALID autolearn=unavailable version=3.3.1 Received: from lists.gnu.org ([140.186.70.17]:34504) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1QqHtN-0002G5-B7 for submit@debbugs.gnu.org; Mon, 08 Aug 2011 00:56:45 -0400 Received: from eggs.gnu.org ([140.186.70.92]:58309) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1QqHtM-0003iJ-AU for bug-gnu-emacs@gnu.org; Mon, 08 Aug 2011 00:56:45 -0400 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1QqHtL-0002CO-9n for bug-gnu-emacs@gnu.org; Mon, 08 Aug 2011 00:56:44 -0400 Received: from caiajhbdcahe.dreamhost.com ([208.97.132.74]:42373 helo=homiemail-a6.g.dreamhost.com) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1QqHtL-00026r-0V for bug-gnu-emacs@gnu.org; Mon, 08 Aug 2011 00:56:43 -0400 Received: from homiemail-a6.g.dreamhost.com (localhost [127.0.0.1]) by homiemail-a6.g.dreamhost.com (Postfix) with ESMTP id EB3ED598076 for ; Sun, 7 Aug 2011 21:56:40 -0700 (PDT) DomainKey-Signature: a=rsa-sha1; c=nofws; d=jidanni.org; h=from:to:subject :date:message-id:mime-version:content-type; q=dns; s=jidanni.org ; b=illra6+PL2xXNbPguoFrzz05WjZxYYzRh2oM7SMCCsE19yC49MQIECh9gjZi ZiSNEjxI0ijB5lPzQCYcMR2Agl+phhVXLcKph1O3/U6s9ONWZ//PGR7XeMJnFJjH vQbgrYYEvwm3gwVEQDvLxajYCpEDSOdEwXNQLIhzDiRAg6g= DKIM-Signature: v=1; a=rsa-sha1; c=relaxed; d=jidanni.org; h=from:to :subject:date:message-id:mime-version:content-type; s= jidanni.org; bh=Z+CsAj6MeUr9eEMUGc8nDZaQpYA=; b=lH00Wu5xkRWOHltZ Bo2HJqTWctgCf7ABUFFTSzLdBob7ZemBBOuRWSmgAZpNF59p6l5MTCZbB9IYsXsq hh9ROrxnwb9aYvn9efdaQdN7AgnlYBKm0Smx1bEUCk6kjlphpsntp2fydWnqJGlm BVPCdjSVfcIvYJoaByWx/iiqUjI= Received: from jidanni.org (218-163-6-13.dynamic.hinet.net [218.163.6.13]) (using TLSv1 with cipher AES256-SHA (256/256 bits)) (No client certificate requested) (Authenticated sender: jidanni@jidanni.org) by homiemail-a6.g.dreamhost.com (Postfix) with ESMTPSA id 9C158598074 for ; Sun, 7 Aug 2011 21:56:40 -0700 (PDT) From: jidanni@jidanni.org Date: Mon, 08 Aug 2011 11:13:06 +0800 Message-ID: <87bow0vbnh.fsf@jidanni.org> MIME-Version: 1.0 Content-Type: text/plain X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.6 (newer, 3) X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.6 (newer, 3) X-Received-From: 140.186.70.17 X-Spam-Score: -5.4 (-----) X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.11 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Sender: debbugs-submit-bounces@debbugs.gnu.org Errors-To: debbugs-submit-bounces@debbugs.gnu.org X-Spam-Score: -5.4 (-----) unless is a Lisp macro in `subr.el'. (unless COND BODY...) If COND yields nil, do BODY, else return nil. <--------what is this line doing here? When COND yields nil, eval BODY forms sequentially and return value of last one, or nil if there are none. From unknown Sun Jun 22 03:58:24 2025 MIME-Version: 1.0 X-Mailer: MIME-tools 5.427 (Entity 5.427) X-Loop: help-debbugs@gnu.org From: help-debbugs@gnu.org (GNU bug Tracking System) To: jidanni@jidanni.org Subject: bug#9259: closed (Re: bug#9259: extra line in "unless" docstring?) Message-ID: References: <87bow0vbnh.fsf@jidanni.org> X-Gnu-PR-Message: they-closed 9259 X-Gnu-PR-Package: emacs Reply-To: 9259@debbugs.gnu.org Date: Mon, 08 Aug 2011 13:54:02 +0000 Content-Type: multipart/mixed; boundary="----------=_1312811642-14434-1" This is a multi-part message in MIME format... ------------=_1312811642-14434-1 Content-Disposition: inline Content-Transfer-Encoding: quoted-printable Content-Type: text/plain; charset="utf-8" Your bug report #9259: extra line in "unless" docstring? which was filed against the emacs package, has been closed. The explanation is attached below, along with your original report. If you require more details, please reply to 9259@debbugs.gnu.org. --=20 9259: http://debbugs.gnu.org/cgi/bugreport.cgi?bug=3D9259 GNU Bug Tracking System Contact help-debbugs@gnu.org with problems ------------=_1312811642-14434-1 Content-Type: message/rfc822 Content-Disposition: inline Content-Transfer-Encoding: 7bit Received: (at 9259-done) by debbugs.gnu.org; 8 Aug 2011 13:53:06 +0000 Received: from localhost ([127.0.0.1] helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.69) (envelope-from ) id 1QqQGN-0003je-Qy for submit@debbugs.gnu.org; Mon, 08 Aug 2011 09:53:05 -0400 Received: from mail-pz0-f47.google.com ([209.85.210.47]) by debbugs.gnu.org with esmtp (Exim 4.69) (envelope-from ) id 1QqQGK-0003jF-Pm for 9259-done@debbugs.gnu.org; Mon, 08 Aug 2011 09:53:02 -0400 Received: by pzk2 with SMTP id 2so7183520pzk.20 for <9259-done@debbugs.gnu.org>; Mon, 08 Aug 2011 06:51:57 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=gamma; h=mime-version:in-reply-to:references:from:date:message-id:subject:to :cc:content-type:content-transfer-encoding; bh=8yA6hRmUIGhwBq60Gq7FFenDFfaBFqUV/zGUqy/K2Ps=; b=bIZYNUvycPkbsh72dfDJaUURHUzPydNC+2KAFi29m/4b9ZbWVnPh6kBEtSMjh4qYNb WIKunHeHdQQuSoMdiLM5pgNBHHgADJg5+0wCoZD04GD9VBkW+CU7CvOasFSeXWN5y3p+ 0GH0QS05Yj6DsbrVlR3sD5FDJu2nbmE+3gLvo= Received: by 10.142.210.3 with SMTP id i3mr4063243wfg.133.1312811517553; Mon, 08 Aug 2011 06:51:57 -0700 (PDT) MIME-Version: 1.0 Received: by 10.142.210.6 with HTTP; Mon, 8 Aug 2011 06:51:15 -0700 (PDT) In-Reply-To: <87bow0vbnh.fsf@jidanni.org> References: <87bow0vbnh.fsf@jidanni.org> From: Juanma Barranquero Date: Mon, 8 Aug 2011 15:51:15 +0200 Message-ID: Subject: Re: bug#9259: extra line in "unless" docstring? To: jidanni@jidanni.org Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: quoted-printable X-Spam-Score: -3.3 (---) X-Debbugs-Envelope-To: 9259-done Cc: 9259-done@debbugs.gnu.org X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.11 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Sender: debbugs-submit-bounces@debbugs.gnu.org Errors-To: debbugs-submit-bounces@debbugs.gnu.org X-Spam-Score: -3.4 (---) > (unless COND BODY...) > > If COND yields nil, do BODY, else return nil. <--------what is this line = doing here? The same happens for `when', BTW. It's not a bug. Most docstrings are written so the first line provides a summary of the corresponding function/macro/special form/variable. This makes the output of apropos more useful. =C2=A0 =C2=A0 Juanma ------------=_1312811642-14434-1 Content-Type: message/rfc822 Content-Disposition: inline Content-Transfer-Encoding: 7bit Received: (at submit) by debbugs.gnu.org; 8 Aug 2011 04:57:49 +0000 Received: from localhost ([127.0.0.1] helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.69) (envelope-from ) id 1QqHuO-0005ut-TC for submit@debbugs.gnu.org; Mon, 08 Aug 2011 00:57:49 -0400 Received: from eggs.gnu.org ([140.186.70.92]) by debbugs.gnu.org with esmtp (Exim 4.69) (envelope-from ) id 1QqHuM-0005uk-JN for submit@debbugs.gnu.org; Mon, 08 Aug 2011 00:57:47 -0400 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1QqHtN-0002GL-Cf for submit@debbugs.gnu.org; Mon, 08 Aug 2011 00:56:46 -0400 X-Spam-Checker-Version: SpamAssassin 3.3.1 (2010-03-16) on eggs.gnu.org X-Spam-Level: X-Spam-Status: No, score=-1.9 required=5.0 tests=BAYES_00, RCVD_IN_DNSWL_NONE, T_DKIM_INVALID autolearn=unavailable version=3.3.1 Received: from lists.gnu.org ([140.186.70.17]:34504) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1QqHtN-0002G5-B7 for submit@debbugs.gnu.org; Mon, 08 Aug 2011 00:56:45 -0400 Received: from eggs.gnu.org ([140.186.70.92]:58309) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1QqHtM-0003iJ-AU for bug-gnu-emacs@gnu.org; Mon, 08 Aug 2011 00:56:45 -0400 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1QqHtL-0002CO-9n for bug-gnu-emacs@gnu.org; Mon, 08 Aug 2011 00:56:44 -0400 Received: from caiajhbdcahe.dreamhost.com ([208.97.132.74]:42373 helo=homiemail-a6.g.dreamhost.com) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1QqHtL-00026r-0V for bug-gnu-emacs@gnu.org; Mon, 08 Aug 2011 00:56:43 -0400 Received: from homiemail-a6.g.dreamhost.com (localhost [127.0.0.1]) by homiemail-a6.g.dreamhost.com (Postfix) with ESMTP id EB3ED598076 for ; Sun, 7 Aug 2011 21:56:40 -0700 (PDT) DomainKey-Signature: a=rsa-sha1; c=nofws; d=jidanni.org; h=from:to:subject :date:message-id:mime-version:content-type; q=dns; s=jidanni.org ; b=illra6+PL2xXNbPguoFrzz05WjZxYYzRh2oM7SMCCsE19yC49MQIECh9gjZi ZiSNEjxI0ijB5lPzQCYcMR2Agl+phhVXLcKph1O3/U6s9ONWZ//PGR7XeMJnFJjH vQbgrYYEvwm3gwVEQDvLxajYCpEDSOdEwXNQLIhzDiRAg6g= DKIM-Signature: v=1; a=rsa-sha1; c=relaxed; d=jidanni.org; h=from:to :subject:date:message-id:mime-version:content-type; s= jidanni.org; bh=Z+CsAj6MeUr9eEMUGc8nDZaQpYA=; b=lH00Wu5xkRWOHltZ Bo2HJqTWctgCf7ABUFFTSzLdBob7ZemBBOuRWSmgAZpNF59p6l5MTCZbB9IYsXsq hh9ROrxnwb9aYvn9efdaQdN7AgnlYBKm0Smx1bEUCk6kjlphpsntp2fydWnqJGlm BVPCdjSVfcIvYJoaByWx/iiqUjI= Received: from jidanni.org (218-163-6-13.dynamic.hinet.net [218.163.6.13]) (using TLSv1 with cipher AES256-SHA (256/256 bits)) (No client certificate requested) (Authenticated sender: jidanni@jidanni.org) by homiemail-a6.g.dreamhost.com (Postfix) with ESMTPSA id 9C158598074 for ; Sun, 7 Aug 2011 21:56:40 -0700 (PDT) From: jidanni@jidanni.org To: bug-gnu-emacs@gnu.org Subject: extra line in "unless" docstring? Date: Mon, 08 Aug 2011 11:13:06 +0800 Message-ID: <87bow0vbnh.fsf@jidanni.org> MIME-Version: 1.0 Content-Type: text/plain X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.6 (newer, 3) X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.6 (newer, 3) X-Received-From: 140.186.70.17 X-Spam-Score: -5.4 (-----) X-Debbugs-Envelope-To: submit X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.11 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Sender: debbugs-submit-bounces@debbugs.gnu.org Errors-To: debbugs-submit-bounces@debbugs.gnu.org X-Spam-Score: -5.4 (-----) unless is a Lisp macro in `subr.el'. (unless COND BODY...) If COND yields nil, do BODY, else return nil. <--------what is this line doing here? When COND yields nil, eval BODY forms sequentially and return value of last one, or nil if there are none. ------------=_1312811642-14434-1-- From unknown Sun Jun 22 03:58:24 2025 X-Loop: help-debbugs@gnu.org Subject: bug#9259: extra line in "unless" docstring? Resent-From: Chong Yidong Original-Sender: debbugs-submit-bounces@debbugs.gnu.org Resent-To: owner@debbugs.gnu.org Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Sat, 20 Aug 2011 21:51:01 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: followup 9259 X-GNU-PR-Package: emacs X-GNU-PR-Keywords: To: jidanni@jidanni.org Cc: 9259@debbugs.gnu.org Received: via spool by 9259-submit@debbugs.gnu.org id=B9259.13138770495014 (code B ref 9259); Sat, 20 Aug 2011 21:51:01 +0000 Received: (at 9259) by debbugs.gnu.org; 20 Aug 2011 21:50:49 +0000 Received: from localhost ([127.0.0.1] helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.69) (envelope-from ) id 1QutRI-0001Ip-WE for submit@debbugs.gnu.org; Sat, 20 Aug 2011 17:50:49 -0400 Received: from vm-emlprdomr-05.its.yale.edu ([130.132.50.146]) by debbugs.gnu.org with esmtp (Exim 4.69) (envelope-from ) id 1QutRH-0001Ii-B7 for 9259@debbugs.gnu.org; Sat, 20 Aug 2011 17:50:48 -0400 Received: from furball ([64.134.100.139]) (authenticated bits=0) by vm-emlprdomr-05.its.yale.edu (8.14.4/8.14.4) with ESMTP id p7KLmXYT030857 (version=TLSv1/SSLv3 cipher=DHE-RSA-AES128-SHA bits=128 verify=NOT); Sat, 20 Aug 2011 17:48:34 -0400 From: Chong Yidong References: <87bow0vbnh.fsf@jidanni.org> Date: Sat, 20 Aug 2011 17:48:32 -0400 In-Reply-To: <87bow0vbnh.fsf@jidanni.org> (jidanni@jidanni.org's message of "Mon, 08 Aug 2011 11:13:06 +0800") Message-ID: <87vctru53j.fsf@stupidchicken.com> User-Agent: Gnus/5.13 (Gnus v5.13) Emacs/24.0.50 (gnu/linux) MIME-Version: 1.0 Content-Type: text/plain X-Scanned-By: MIMEDefang 2.71 on 130.132.50.146 X-Spam-Score: -2.6 (--) X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.11 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Sender: debbugs-submit-bounces@debbugs.gnu.org Errors-To: debbugs-submit-bounces@debbugs.gnu.org X-Spam-Score: -2.6 (--) jidanni@jidanni.org writes: > unless is a Lisp macro in `subr.el'. > > (unless COND BODY...) > > If COND yields nil, do BODY, else return nil. <--------what is this > line doing here? > When COND yields nil, eval BODY forms sequentially and return > value of last one, or nil if there are none. It's the one-line summary of the function. Every docstring has one. From unknown Sun Jun 22 03:58:24 2025 X-Loop: help-debbugs@gnu.org Subject: bug#9259: extra line in "unless" docstring? In-Reply-To: <87bow0vbnh.fsf@jidanni.org> Resent-From: jidanni@jidanni.org Original-Sender: debbugs-submit-bounces@debbugs.gnu.org Resent-To: owner@debbugs.gnu.org Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Sat, 20 Aug 2011 22:18:02 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: followup 9259 X-GNU-PR-Package: emacs X-GNU-PR-Keywords: To: cyd@stupidchicken.com Cc: 9259@debbugs.gnu.org Received: via spool by 9259-submit@debbugs.gnu.org id=B9259.131387865412549 (code B ref 9259); Sat, 20 Aug 2011 22:18:02 +0000 Received: (at 9259) by debbugs.gnu.org; 20 Aug 2011 22:17:34 +0000 Received: from localhost ([127.0.0.1] helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.69) (envelope-from ) id 1QutrB-0003GL-EK for submit@debbugs.gnu.org; Sat, 20 Aug 2011 18:17:34 -0400 Received: from caiajhbdcagg.dreamhost.com ([208.97.132.66] helo=homiemail-a61.g.dreamhost.com) by debbugs.gnu.org with esmtp (Exim 4.69) (envelope-from ) id 1Qutr9-0003GE-6H for 9259@debbugs.gnu.org; Sat, 20 Aug 2011 18:17:32 -0400 Received: from homiemail-a61.g.dreamhost.com (localhost [127.0.0.1]) by homiemail-a61.g.dreamhost.com (Postfix) with ESMTP id AED0657806E; Sat, 20 Aug 2011 15:15:17 -0700 (PDT) DomainKey-Signature: a=rsa-sha1; c=nofws; d=jidanni.org; h=from:to:cc:subject :references:date:message-id:mime-version:content-type; q=dns; s= jidanni.org; b=kHMUh988PW7OyKbp/KDRkwsZ4VhWMgiwetgnuGVyix6stUgJf FMF3SwhcepXgIszPmyL2xKAEcS9vg4TuWSI4GZZdA65z+fIBlwzmlIcckFFh3p6x uAYWlFrJyaPSaM88Ft15RbZ9wafgHroODsDo3svVFdm1gGdzgygZiYRCxo= DKIM-Signature: v=1; a=rsa-sha1; c=relaxed; d=jidanni.org; h=from:to:cc :subject:references:date:message-id:mime-version:content-type; s=jidanni.org; bh=YZSW+saOvAGUM1qxNd84GQLL9Xg=; b=ALsykjLmHXsQW 2chpboVfpSP3TE+LiCF5gEKJF9rrugPyRKn0bfgNCSAZgO4w+HVSlKWnP67ffKZI dJs2b/IsMf77PBbhYs9ebYE2XJ4kN2b3IQlzyRcq8N7SV7NnxjvG/e/s0ZcuYPjA B7M9Vm1Xx1QxWYo5vvKQiak0NGIcmc= Received: from jidanni.org (218-163-0-141.dynamic.hinet.net [218.163.0.141]) (using TLSv1 with cipher AES256-SHA (256/256 bits)) (No client certificate requested) (Authenticated sender: jidanni@jidanni.org) by homiemail-a61.g.dreamhost.com (Postfix) with ESMTPSA id 4FECE578059; Sat, 20 Aug 2011 15:15:17 -0700 (PDT) From: jidanni@jidanni.org References: <87vctru53j.fsf@stupidchicken.com> Date: Sun, 21 Aug 2011 06:15:14 +0800 Message-ID: <87fwkv4tn1.fsf@jidanni.org> MIME-Version: 1.0 Content-Type: text/plain X-Spam-Score: -3.4 (---) X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.11 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Sender: debbugs-submit-bounces@debbugs.gnu.org Errors-To: debbugs-submit-bounces@debbugs.gnu.org X-Spam-Score: -3.4 (---) >>>>> "CY" == Chong Yidong writes: CY> jidanni@jidanni.org writes: >> unless is a Lisp macro in `subr.el'. >> >> (unless COND BODY...) >> >> If COND yields nil, do BODY, else return nil. <--------what is this >> line doing here? >> When COND yields nil, eval BODY forms sequentially and return >> value of last one, or nil if there are none. CY> It's the one-line summary of the function. Every docstring has one. Well e.g., man pages have headers "SUMMARY" etc. separating the different parts. If the rendering jammed them all together it would look bad. Even in debian apt there is indentation: Description: Web browser based on Firefox Iceweasel is Firefox, rebranded. It is a powerful, extensible web browser with support for modern web application technologies.