unofficial mirror of guile-devel@gnu.org 
 help / color / mirror / Atom feed
* doc: fix documented keyword argument default to match code
@ 2022-08-17 13:34 Vijay Marupudi
  2022-12-15 17:45 ` Vijay Marupudi
  0 siblings, 1 reply; 4+ messages in thread
From: Vijay Marupudi @ 2022-08-17 13:34 UTC (permalink / raw)
  To: guile-devel


[-- Attachment #1.1: Type: text/plain, Size: 138 bytes --]

Hello,

I've attached a simple documentation bugfix patch for getopt-long,
`#:stop-at-first-non-option' defaults to #f, not #t.

~ Vijay


[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #1.2: 0001-doc-fix-documented-keyword-argument-default-to-match.patch --]
[-- Type: text/x-patch, Size: 989 bytes --]

From 852d9eee636a0be61ea3e0fab88a5780971d33c2 Mon Sep 17 00:00:00 2001
From: Vijay Marupudi <vijay@vijaymarupudi.com>
Date: Wed, 17 Aug 2022 09:13:18 -0400
Subject: [PATCH] doc: fix documented keyword argument default to match code
 default

---
 doc/ref/mod-getopt-long.texi | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/doc/ref/mod-getopt-long.texi b/doc/ref/mod-getopt-long.texi
index cf043418f..e3dcc33e8 100644
--- a/doc/ref/mod-getopt-long.texi
+++ b/doc/ref/mod-getopt-long.texi
@@ -261,7 +261,7 @@ as ordinary argument strings.
 @node getopt-long Reference
 @subsection Reference Documentation for @code{getopt-long}
 
-@deffn {Scheme Procedure} getopt-long args grammar [#:stop-at-first-non-option #t]
+@deffn {Scheme Procedure} getopt-long args grammar [#:stop-at-first-non-option #f]
 Parse the command line given in @var{args} (which must be a list of
 strings) according to the option specification @var{grammar}.
 
-- 
2.37.2


[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 519 bytes --]

^ permalink raw reply related	[flat|nested] 4+ messages in thread

* Re: doc: fix documented keyword argument default to match code
  2022-08-17 13:34 doc: fix documented keyword argument default to match code Vijay Marupudi
@ 2022-12-15 17:45 ` Vijay Marupudi
  2022-12-15 18:02   ` Aleix Conchillo Flaqué
  0 siblings, 1 reply; 4+ messages in thread
From: Vijay Marupudi @ 2022-12-15 17:45 UTC (permalink / raw)
  To: guile-devel

[-- Attachment #1: Type: text/plain, Size: 96 bytes --]

Hello guile-devel,

Bumping this simple documentation bug fix to (ice-9 getopt-long).

~ Vijay


[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #2: 0001-doc-fix-documented-keyword-argument-default-to-match.patch --]
[-- Type: text/x-patch, Size: 963 bytes --]

From 852d9eee636a0be61ea3e0fab88a5780971d33c2 Mon Sep 17 00:00:00 2001
From: Vijay Marupudi <vijay@vijaymarupudi.com>
Date: Wed, 17 Aug 2022 09:13:18 -0400
Subject: [PATCH] doc: fix documented keyword argument default to match code
 default

---
 doc/ref/mod-getopt-long.texi | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/doc/ref/mod-getopt-long.texi b/doc/ref/mod-getopt-long.texi
index cf043418f..e3dcc33e8 100644
--- a/doc/ref/mod-getopt-long.texi
+++ b/doc/ref/mod-getopt-long.texi
@@ -261,7 +261,7 @@ as ordinary argument strings.
 @node getopt-long Reference
 @subsection Reference Documentation for @code{getopt-long}
 
-@deffn {Scheme Procedure} getopt-long args grammar [#:stop-at-first-non-option #t]
+@deffn {Scheme Procedure} getopt-long args grammar [#:stop-at-first-non-option #f]
 Parse the command line given in @var{args} (which must be a list of
 strings) according to the option specification @var{grammar}.
 
-- 
2.37.2


^ permalink raw reply related	[flat|nested] 4+ messages in thread

* Re: doc: fix documented keyword argument default to match code
  2022-12-15 17:45 ` Vijay Marupudi
@ 2022-12-15 18:02   ` Aleix Conchillo Flaqué
  2022-12-21  7:31     ` N. Dal
  0 siblings, 1 reply; 4+ messages in thread
From: Aleix Conchillo Flaqué @ 2022-12-15 18:02 UTC (permalink / raw)
  To: Vijay Marupudi; +Cc: guile-devel

[-- Attachment #1: Type: text/plain, Size: 358 bytes --]

On Thu, Dec 15, 2022 at 9:46 AM Vijay Marupudi <vijay@vijaymarupudi.com>
wrote:

> Hello guile-devel,
>
> Bumping this simple documentation bug fix to (ice-9 getopt-long).
>

LGTM.

Procedure is:

(define* (getopt-long program-arguments option-desc-list
                      #:key stop-at-first-non-option)

And by default this means #f. So, it looks good.

[-- Attachment #2: Type: text/html, Size: 1369 bytes --]

^ permalink raw reply	[flat|nested] 4+ messages in thread

* Re: doc: fix documented keyword argument default to match code
  2022-12-15 18:02   ` Aleix Conchillo Flaqué
@ 2022-12-21  7:31     ` N. Dal
  0 siblings, 0 replies; 4+ messages in thread
From: N. Dal @ 2022-12-21  7:31 UTC (permalink / raw)
  To: Aleix Conchillo Flaqué; +Cc: Vijay Marupudi, guile-devel


Committed to 8cb2d5c9532f0f5ce3b5b97edefdf98e57b63738. 

Thank you

  Daniel





^ permalink raw reply	[flat|nested] 4+ messages in thread

end of thread, other threads:[~2022-12-21  7:31 UTC | newest]

Thread overview: 4+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2022-08-17 13:34 doc: fix documented keyword argument default to match code Vijay Marupudi
2022-12-15 17:45 ` Vijay Marupudi
2022-12-15 18:02   ` Aleix Conchillo Flaqué
2022-12-21  7:31     ` N. Dal

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).