[issue27188] sqlite3 execute* methods return value not documented

[Berker Peksag]

Berker Peksag added the comment:

Thanks for the patch Dave. I found a couple of more issues while reviewing the 
patch and fixed them.

--
resolution:  -> fixed
stage: patch review -> resolved
status: open -> closed

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue27188] sqlite3 execute* methods return value not documented

[Roundup Robot]

Roundup Robot added the comment:

New changeset a825aee0721f by Berker Peksag in branch '3.5':
Issue #27188: Fix various sqlite3 documentation errors
https://hg.python.org/cpython/rev/a825aee0721f

New changeset 187b2bc0fe26 by Berker Peksag in branch 'default':
Issue #27188: Merge from 3.5
https://hg.python.org/cpython/rev/187b2bc0fe26

--
nosy: +python-dev

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue27188] sqlite3 execute* methods return value not documented

[Dave Sawyer]

Dave Sawyer added the comment:

No problem. I did a pull and reposted with additional fixes suggested by
Berker and one copy/paste error I spotted.

On Sat, Jun 4, 2016 at 11:34 PM, SilentGhost  wrote:

>
> SilentGhost added the comment:
>
> Thanks for the patch, Dave. For whatever reason it doesn't seem to apply
> cleanly to the current tip, would you mind preparing a new patch that does?
>
> --
> assignee:  -> docs@python
> components: +Documentation
> nosy: +SilentGhost, berker.peksag, docs@python, ghaering
> stage:  -> patch review
> type: enhancement -> behavior
>
> ___
> Python tracker 
> 
> ___
>

--

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue27188] sqlite3 execute* methods return value not documented

[Dave Sawyer]

Dave Sawyer added the comment:

Updated optional parameters. Fixed executescript which takes a single 
parameter. The English is correct - one needs to looks at the verbs to be sure 
they match in tense and number. Like "He OPENS the fridge, GRABS the milk, and 
DRINKS it." This method CREATES a cursor, CALLS the method, and RETURNS the 
cursor.

--
Added file: http://bugs.python.org/file43269/issue27188_patch2.txt

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue27188] sqlite3 execute* methods return value not documented

[Berker Peksag]

Berker Peksag added the comment:

Could you also change the function signatures from

.. method:: execute(sql, [parameters])

to

.. method:: execute(sql[, parameters])

and document that parameters should be list (or sequence or iterable -- I'm a 
the airport now so I can't check what is the correct term)?

I'm not a native speaker but this sentence sounds a bit weird to me:

This is a nonstandard shortcut that creates a cursor object by calling the 
cursor method, calls the cursor's :meth:`execute ` [...]

Perhaps it can be changed to


This is a nonstandard shortcut that creates a cursor object by calling the 
cursor's :meth:`execute ` method [...]

Also, please change the following usages

:meth:`execute `

with

:meth:`~Cursor.execute`

--
versions: +Python 3.5

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue27188] sqlite3 execute* methods return value not documented

[SilentGhost]

SilentGhost added the comment:

Thanks for the patch, Dave. For whatever reason it doesn't seem to apply 
cleanly to the current tip, would you mind preparing a new patch that does?

--
assignee:  -> docs@python
components: +Documentation
nosy: +SilentGhost, berker.peksag, docs@python, ghaering
stage:  -> patch review
type: enhancement -> behavior

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue27188] sqlite3 execute* methods return value not documented

[Dave Sawyer]

New submission from Dave Sawyer:

The three execute methods of the connection object return the created cursor. 
The term "intermediate" implies the cursor is totally handled by the execute 
method, not that the user will get ownership of the object. 

When the user doesn't call close() on the returned cursor right away, they hold 
a lock on the database until the object is garbage collected.

--
files: execdoc_patch1.txt
messages: 266964
nosy: Dave Sawyer
priority: normal
severity: normal
status: open
title: sqlite3 execute* methods return value not documented
type: enhancement
versions: Python 3.6
Added file: http://bugs.python.org/file43120/execdoc_patch1.txt

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com