From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!not-for-mail From: ludo@gnu.org (Ludovic =?utf-8?Q?Court=C3=A8s?=) Newsgroups: gmane.lisp.guile.devel Subject: Re: [PATCH] Implement doctest utility as guild script Date: Sun, 29 Sep 2013 21:14:37 +0200 Message-ID: <87ioxjh23m.fsf@gnu.org> References: <1380343789-1590-1-git-send-email-KAction@gnu.org> <871u47kdgn.fsf@gnu.org> <87li2fd0ah.fsf@gnu.org> NNTP-Posting-Host: plane.gmane.org Mime-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: quoted-printable X-Trace: ger.gmane.org 1380482403 24617 80.91.229.3 (29 Sep 2013 19:20:03 GMT) X-Complaints-To: usenet@ger.gmane.org NNTP-Posting-Date: Sun, 29 Sep 2013 19:20:03 +0000 (UTC) Cc: guile-devel@gnu.org To: Dmitry Bogatov Original-X-From: guile-devel-bounces+guile-devel=m.gmane.org@gnu.org Sun Sep 29 21:20:05 2013 Return-path: Envelope-to: guile-devel@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 1VQMXE-00032w-I9 for guile-devel@m.gmane.org; Sun, 29 Sep 2013 21:20:04 +0200 Original-Received: from localhost ([::1]:45720 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1VQMXD-0004Es-V0 for guile-devel@m.gmane.org; Sun, 29 Sep 2013 15:20:03 -0400 Original-Received: from eggs.gnu.org ([2001:4830:134:3::10]:34221) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1VQMX3-0004EW-NY for guile-devel@gnu.org; Sun, 29 Sep 2013 15:20:00 -0400 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1VQMWx-0003pq-27 for guile-devel@gnu.org; Sun, 29 Sep 2013 15:19:53 -0400 Original-Received: from hera.aquilenet.fr ([141.255.128.1]:45853) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1VQMWq-0003ot-3n; Sun, 29 Sep 2013 15:19:40 -0400 Original-Received: from localhost (localhost [127.0.0.1]) by hera.aquilenet.fr (Postfix) with ESMTP id 59982DE2; Sun, 29 Sep 2013 21:14:38 +0200 (CEST) Original-Received: from hera.aquilenet.fr ([127.0.0.1]) by localhost (hera.aquilenet.fr [127.0.0.1]) (amavisd-new, port 10024) with ESMTP id XryAH7rmg8bt; Sun, 29 Sep 2013 21:14:38 +0200 (CEST) Original-Received: from pluto (reverse-83.fdn.fr [80.67.176.83]) by hera.aquilenet.fr (Postfix) with ESMTPSA id F23CF431; Sun, 29 Sep 2013 21:14:37 +0200 (CEST) X-URL: http://www.fdn.fr/~lcourtes/ X-Revolutionary-Date: 8 =?utf-8?Q?Vend=C3=A9miaire?= an 222 de la =?utf-8?Q?R=C3=A9volution?= X-PGP-Key-ID: 0xEA52ECF4 X-PGP-Key: http://www.fdn.fr/~lcourtes/ludovic.asc X-PGP-Fingerprint: 83C4 F8E5 10A3 3B4C 5BEA D15D 77DD 95E2 EA52 ECF4 X-OS: x86_64-unknown-linux-gnu In-Reply-To: <87li2fd0ah.fsf@gnu.org> (Dmitry Bogatov's message of "Sun, 29 Sep 2013 21:07:18 +0400") User-Agent: Gnus/5.130007 (Ma Gnus v0.7) Emacs/24.3 (gnu/linux) X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.6.x [fuzzy] X-Received-From: 141.255.128.1 X-BeenThere: guile-devel@gnu.org X-Mailman-Version: 2.1.14 Precedence: list List-Id: "Developers list for Guile, the GNU extensibility library" List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: guile-devel-bounces+guile-devel=m.gmane.org@gnu.org Original-Sender: guile-devel-bounces+guile-devel=m.gmane.org@gnu.org Xref: news.gmane.org gmane.lisp.guile.devel:16654 Archived-At: Dmitry Bogatov skribis: > Ludovic Court=C3=A8s writes: > >> I share Ian Price=E2=80=99s concerns regarding the fundamental idea behi= nd >> doctest. Namely, writing code in strings means that syntax errors can >> only be detected very late, and that the code in there cannot easily >> refer to anything outside; > What do you mean outside? I think it encourages pure function. I meant that sometimes you want to factorize helpers for the test suite as separate procedures/macros, and it may be tricky to use them from within the docstring. >> furthermore, that pollutes docstrings, whose >> goal is to provide a help string for users. > Definitely right. At current state. But it is possible to separate > actual english documentation string and doctests. Displaying them > in (help function-name) may be turned off or, imho (since I like examples > in documentation), better, made optional. OK, but that=E2=80=99s not supported yet. :-) Thanks, Ludo=E2=80=99.