bug#58885: 29.0.50; Incorrect sqlite-select docstring

bug#58885: 29.0.50; Incorrect sqlite-select docstring

[Andrew Hyatt]

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

 

The docstring for sqlite-select says "By default, the return value 
is a list where the first element is a list of column names, and 
the rest of the elements are the matching data." But this isn't 
true, by default, the value of RETURN-TYPE in that function is 
nil, which does not prepend the list of column names. I don't 
think anything more is necessary then removing this line, because 
the rest of the docstring has sufficient explanation.

Patch included.


[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #2: docstring fix --]
[-- Type: text/x-patch, Size: 691 bytes --]

diff --git a/src/sqlite.c b/src/sqlite.c
index d6cb38a29a..095ce73030 100644
--- a/src/sqlite.c
+++ b/src/sqlite.c
@@ -528,9 +528,6 @@ DEFUN ("sqlite-select", Fsqlite_select, Ssqlite_select, 2, 4, 0,
 If VALUES is non-nil, it should be a list or a vector specifying the
 values that will be interpolated into a parameterized statement.
 
-By default, the return value is a list where the first element is a
-list of column names, and the rest of the elements are the matching data.
-
 RETURN-TYPE can be either nil (which means that the matching data
 should be returned as a list of rows), or `full' (the same, but the
 first element in the return list will be the column names), or `set',

bug#58885: 29.0.50; Incorrect sqlite-select docstring

[Eli Zaretskii]

> From: Andrew Hyatt <ahyatt@gmail.com>
> Date: Sun, 30 Oct 2022 00:54:17 -0400
> 
> The docstring for sqlite-select says "By default, the return value 
> is a list where the first element is a list of column names, and 
> the rest of the elements are the matching data." But this isn't 
> true, by default, the value of RETURN-TYPE in that function is 
> nil, which does not prepend the list of column names. I don't 
> think anything more is necessary then removing this line, because 
> the rest of the docstring has sufficient explanation.
> 
> Patch included.

Thanks.  I think it does make sense to say that the default return
value is a list.  So I fixed this in a different way, please take a
look.

bug#58885: 29.0.50; Incorrect sqlite-select docstring

[Andrew Hyatt]

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

On Sun, Oct 30, 2022 at 4:32 AM Eli Zaretskii <eliz@gnu.org> wrote:

> > From: Andrew Hyatt <ahyatt@gmail.com>
> > Date: Sun, 30 Oct 2022 00:54:17 -0400
> >
> > The docstring for sqlite-select says "By default, the return value
> > is a list where the first element is a list of column names, and
> > the rest of the elements are the matching data." But this isn't
> > true, by default, the value of RETURN-TYPE in that function is
> > nil, which does not prepend the list of column names. I don't
> > think anything more is necessary then removing this line, because
> > the rest of the docstring has sufficient explanation.
> >
> > Patch included.
>
> Thanks.  I think it does make sense to say that the default return
> value is a list.  So I fixed this in a different way, please take a
> look.
>

The change you made looks good, thank you.

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

bug#58885: 29.0.50; Incorrect sqlite-select docstring

[Eli Zaretskii]

> From: Andrew Hyatt <ahyatt@gmail.com>
> Date: Sun, 30 Oct 2022 10:30:26 -0400
> Cc: 58885@debbugs.gnu.org
> 
>  Thanks.  I think it does make sense to say that the default return
>  value is a list.  So I fixed this in a different way, please take a
>  look.
> 
> The change you made looks good, thank you.  

OK, closing.