Add NumPyDoc docstring to BaseCursor.execute
* Parameters explained * Return value explained
This commit is contained in:
committed by
INADA Naoki
parent
9724752d3c
commit
abbf34d1be
@@ -137,7 +137,26 @@ class Cursor(object):
|
||||
return query
|
||||
|
||||
def execute(self, query, args=None):
|
||||
'''Execute a query'''
|
||||
"""
|
||||
Execute a query
|
||||
|
||||
Parameters
|
||||
----------
|
||||
query : str
|
||||
Query to execute on the server.
|
||||
args : tuple, list or dict, optional
|
||||
Will be used with query
|
||||
|
||||
Returns
|
||||
-------
|
||||
int
|
||||
Number of affected rows
|
||||
|
||||
Notes
|
||||
-----
|
||||
If args is a sequence, %s can be used as a placeholder in the query.
|
||||
If args is a dict, %(name)s can be used as a placeholder in the query.
|
||||
"""
|
||||
while self.nextset():
|
||||
pass
|
||||
|
||||
|
||||
Reference in New Issue
Block a user