Merge pull request sigmavirus24#232 from BenediktSeidl/develop

sigmavirus24 · sigmavirus24 · commit ad7d330c8111 · 2014-05-04T14:06:39.000-05:00
Update documentation of Github.create_issue
diff --git a/github3/github.py b/github3/github.py
@@ -180,10 +180,13 @@ def create_issue(self,
             formatted
         :param str assignee: (optional), Login of person to assign
             the issue to
-        :param str milestone: (optional), Which milestone to assign
-            the issue to
+        :param int milestone: (optional), id number of the milestone to
+            attribute this issue to (e.g. ``m`` is a :class:`Milestone
+            <github3.issues.Milestone>` object, ``m.number`` is what you pass
+            here.)
         :param list labels: (optional), List of label names.
-        :returns: :class:`Issue <github3.issues.Issue>`
+        :returns: :class:`Issue <github3.issues.Issue>` if successful, else
+            None
         """
         repo = None
         if owner and repository and title:
