Merge remote-tracking branch 'origin/develop' into consistency-is-a-hobgoblin

sigmavirus24 · sigmavirus24 · commit e73bb361459e · 2018-01-15T23:21:50.000-06:00
diff --git a/github3/pulls.py b/github3/pulls.py
@@ -375,21 +375,27 @@ def issue_comments(self, number=-1, etag=None):
         return self._iter(int(number), url, IssueComment, etag=etag)
 
     @requires_auth
-    def merge(self, commit_message=None, sha=None, squash=False):
+    def merge(self, commit_message=None, sha=None, merge_method='merge'):
         """Merge this pull request.
 
+        .. versionchanged:: 1.0.0
+
+            The boolean ``squash`` parameter has been replaced with
+            ``merge_method`` which requires a string.
+
         :param str commit_message:
             (optional), message to be used for the merge commit
         :param str sha:
             (optional), SHA that pull request head must match to merge.
-        :param bool squash:
-            (optional), commit a single commit to the head branch.
+        :param str merge_method: (optional), Change the merge method.
+            Either 'merge', 'squash' or 'rebase'. Default is 'merge'.
         :returns:
             True if successful, False otherwise
         :rtype:
             bool
+        :returns: bool
         """
-        parameters = {'squash': squash}
+        parameters = {'merge_method': merge_method}
         if sha:
             parameters['sha'] = sha
         if commit_message is not None:
diff --git a/tests/unit/test_pulls.py b/tests/unit/test_pulls.py
@@ -99,16 +99,16 @@ def test_merge(self):
 
         self.put_called_with(
             url_for('merge'),
-            data={"squash": False}
+            data={"merge_method": "merge"}
         )
 
     def test_merge_squash_message(self):
         """Show that a user can merge a Pull Request."""
-        self.instance.merge('commit message', squash=True)
+        self.instance.merge('commit message', merge_method='squash')
 
         self.put_called_with(
             url_for('merge'),
-            data={"squash": True, "commit_message": "commit message"}
+            data={"merge_method": "squash", "commit_message": "commit message"}
         )
 
     def test_patch(self):
