From 19e62491d5b2e000b3a01a3a06b42f0af46c115f Mon Sep 17 00:00:00 2001 From: INADA Naoki Date: Wed, 24 Feb 2016 19:35:32 +0900 Subject: [PATCH] Use sphinx style --- pymysql/cursors.py | 23 ++++++++--------------- 1 file changed, 8 insertions(+), 15 deletions(-) diff --git a/pymysql/cursors.py b/pymysql/cursors.py index 41b3858..69a41f4 100644 --- a/pymysql/cursors.py +++ b/pymysql/cursors.py @@ -137,24 +137,17 @@ 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 + :param str query: Query to execute. - Returns - ------- - int - Number of affected rows + :param args: arameters used with query. (optional) + :type args: tuple, list or dict - Notes - ----- - If args is a sequence, %s can be used as a placeholder in the query. + :return: Number of affected rows + :rtype: int + + If args is a list or tuple, %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():