Add NumPyDoc docstring to BaseCursor.execute

MartinThoma · methane · commit abbf34d1be3e · 2016-02-24T19:31:34.000+09:00
* Parameters explained
* Return value explained
diff --git a/pymysql/cursors.py b/pymysql/cursors.py
@@ -137,7 +137,26 @@ def mogrify(self, query, args=None):
         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
 
