Deprecate the assign method

jacquerie · jacquerie · commit 8e226d75cfc8 · 2018-08-04T14:48:38.000+02:00
This method leveraged the deprecated `assignee` argument of the
`edit` method. It is deprecated in favor of the `add_assignees`
method, which uses the `assignees` argument instead.
diff --git a/src/github3/issues/issue.py b/src/github3/issues/issue.py
@@ -2,6 +2,7 @@
 """Module containing the Issue logic."""
 from __future__ import unicode_literals
 
+import warnings
 from json import dumps
 
 from uritemplate import URITemplate
@@ -107,6 +108,10 @@ def add_labels(self, *args):
     def assign(self, username):
         """Assign user ``username`` to this issue.
 
+        .. deprecated:: 1.2.0
+
+            Use :meth:`github3.issues.issue.Issue.add_assignees` instead.
+
         This is a short cut for :meth:`~github3.issues.issue.Issue.edit`.
 
         :param str username:
@@ -116,6 +121,9 @@ def assign(self, username):
         :rtype:
             bool
         """
+        warnings.warn(
+            'This method is deprecated. Please use ``add_assignees`` '
+            'instead.', DeprecationWarning, stacklevel=2)
         if not username:
             return False
         number = self.milestone.number if self.milestone else None
