From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!not-for-mail From: Daniel Hartwig Newsgroups: gmane.lisp.guile.bugs Subject: bug#10522: Patch: Improve optional variable and keyword notation in manual Date: Sun, 3 Mar 2013 09:07:24 +0800 Message-ID: References: <87d3ajh1lt.fsf@goof.localdomain> <87obtgjbag.fsf@pobox.com> <876219egqv.fsf@pobox.com> NNTP-Posting-Host: plane.gmane.org Mime-Version: 1.0 Content-Type: text/plain; charset=UTF-8 X-Trace: ger.gmane.org 1362272884 1412 80.91.229.3 (3 Mar 2013 01:08:04 GMT) X-Complaints-To: usenet@ger.gmane.org NNTP-Posting-Date: Sun, 3 Mar 2013 01:08:04 +0000 (UTC) Cc: guile-devel , 10522@debbugs.gnu.org To: Andy Wingo Original-X-From: bug-guile-bounces+guile-bugs=m.gmane.org@gnu.org Sun Mar 03 02:08:25 2013 Return-path: Envelope-to: guile-bugs@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 1UBxPc-0006pb-Ms for guile-bugs@m.gmane.org; Sun, 03 Mar 2013 02:08:24 +0100 Original-Received: from localhost ([::1]:40089 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1UBxPH-0006yL-C6 for guile-bugs@m.gmane.org; Sat, 02 Mar 2013 20:08:03 -0500 Original-Received: from eggs.gnu.org ([208.118.235.92]:40951) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1UBxPD-0006yG-8G for bug-guile@gnu.org; Sat, 02 Mar 2013 20:08:00 -0500 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1UBxPA-00058d-U2 for bug-guile@gnu.org; Sat, 02 Mar 2013 20:07:59 -0500 Original-Received: from debbugs.gnu.org ([140.186.70.43]:51948) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1UBxPA-00058W-Q5 for bug-guile@gnu.org; Sat, 02 Mar 2013 20:07:56 -0500 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.72) (envelope-from ) id 1UBxPG-00065t-At for bug-guile@gnu.org; Sat, 02 Mar 2013 20:08:02 -0500 X-Loop: help-debbugs@gnu.org Resent-From: Daniel Hartwig Original-Sender: debbugs-submit-bounces@debbugs.gnu.org Resent-CC: bug-guile@gnu.org Resent-Date: Sun, 03 Mar 2013 01:08:02 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: followup 10522 X-GNU-PR-Package: guile X-GNU-PR-Keywords: Original-Received: via spool by 10522-submit@debbugs.gnu.org id=B10522.136227285923397 (code B ref 10522); Sun, 03 Mar 2013 01:08:02 +0000 Original-Received: (at 10522) by debbugs.gnu.org; 3 Mar 2013 01:07:39 +0000 Original-Received: from localhost ([127.0.0.1]:56057 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.72) (envelope-from ) id 1UBxOs-00065H-Rn for submit@debbugs.gnu.org; Sat, 02 Mar 2013 20:07:39 -0500 Original-Received: from mail-ie0-f170.google.com ([209.85.223.170]:59571) by debbugs.gnu.org with esmtp (Exim 4.72) (envelope-from ) id 1UBxOq-000655-CN for 10522@debbugs.gnu.org; Sat, 02 Mar 2013 20:07:37 -0500 Original-Received: by mail-ie0-f170.google.com with SMTP id c11so4972758ieb.1 for <10522@debbugs.gnu.org>; Sat, 02 Mar 2013 17:07:24 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20120113; h=mime-version:x-received:in-reply-to:references:date:message-id :subject:from:to:cc:content-type; bh=VF2X8kEfp9f1bvohdElb3Stejm5Z1Gbfj6d1c2bO5/4=; b=WA34770sdyKHz/SG9nQV/K0KvTqUVCX2hUUkWxAKotiXQnjUCU3PSczI6V+0mI2zLb FkqFmyNkjTUPqJao9v5KyWVSVojVqboKQF73Ly2khMUyTGIb4AD3C4qa7lIIJTG4HOwq f3CDRrSTNLZnYt0LGEQqT8jeOBjrxNBL6lcZ8hxeg/AY3eKDXhwUnHRomboguHQuSsBT spFntEsTiEEmzjjgjX8v/8wHuRYAsjPBNWgk/MPNRGhMlVlzXyL3JRydJ/WjLaSHXfri mBuKIQ+L1U2ST7NcgprkpVRrlZ4vM+dRW64DI8uHz2fnq8t0nhRHSf1WeX5sMreF3E1l NGpg== X-Received: by 10.43.65.195 with SMTP id xn3mr18289081icb.5.1362272844751; Sat, 02 Mar 2013 17:07:24 -0800 (PST) Original-Received: by 10.64.26.168 with HTTP; Sat, 2 Mar 2013 17:07:24 -0800 (PST) In-Reply-To: <876219egqv.fsf@pobox.com> X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.13 Precedence: list X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.6.x X-Received-From: 140.186.70.43 X-BeenThere: bug-guile@gnu.org List-Id: "Bug reports for GUILE, GNU's Ubiquitous Extension Language" List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: bug-guile-bounces+guile-bugs=m.gmane.org@gnu.org Original-Sender: bug-guile-bounces+guile-bugs=m.gmane.org@gnu.org Xref: news.gmane.org gmane.lisp.guile.bugs:6826 Archived-At: On 3 March 2013 03:36, Andy Wingo wrote: > Hi Bake, > > On Fri 03 Feb 2012 14:28, Andy Wingo writes: > >> Hi Bake, >> >> This patch looks great. I do have a couple of comments before >> applying. It would probably be useful to have input from others as >> well, so I'm copying guile-devel. >> >> On Mon 16 Jan 2012 20:46, Bake Timmons writes: >>> -@deffn {Scheme Procedure} resolve-module name [autoload=#t] [version=#f] [#:ensure=#t] >>> +@deffn {Scheme Procedure} resolve-module name [autoload=#t [version=#f]] @ >>> + [#:ensure ensure=#t] >> >> Nesting the optional arguments in brackets can get a bit ugly. It is >> precise but verbose. But I suppose we should not encourage interfaces >> with many optional arguments, so perhaps it is a moot point. >> >> Also, it seems pedantic to repeat the keyword arguments (once as >> keyword, once as identifier). Surely #:foo=bar is unambiguous? > > A year later, I pushed a version of your patch that doesn't nest > optional arguments or duplicate the keyword argument names, but it does > apply the other changes (and it makes keyword argument notation more > consistent). Thanks for the patch, and looking forward to more of them > :) Can I ask whether it is preferred to use, e.g. @code{#f}, for the default values, as some places seem to and others don't. This patch is not using @code, but then, neither does it touch any doc. that was previously.