diff --git a/doc/examples.rst b/doc/examples.rst index 518a1da9ec..bb6f356a73 100644 --- a/doc/examples.rst +++ b/doc/examples.rst @@ -6,4 +6,6 @@ Examples examples/MainClass examples/Repository examples/Commit - examples/PullRequest \ No newline at end of file + examples/PullRequest + examples/Issue + examples/Milestone \ No newline at end of file diff --git a/doc/examples/Issue.rst b/doc/examples/Issue.rst new file mode 100644 index 0000000000..280eea442a --- /dev/null +++ b/doc/examples/Issue.rst @@ -0,0 +1,58 @@ +Issues +====== + +Get issue +--------- + +.. code-block:: python + + >>> repo = g.get_repo("PyGithub/PyGithub") + >>> repo.get_issue(number=874) + Issue(title="PyGithub example usage", number=874) + +Create issue +------------ + +.. code-block:: python + + >>> repo = g.get_repo("PyGithub/PyGithub") + >>> repo.create_issue(title="This is a new issue") + Issue(title="This is a new issue", number=XXX) + +Create issue with body +---------------------- + +.. code-block:: python + + >>> repo = g.get_repo("PyGithub/PyGithub") + >>> repo.create_issue(title="This is a new issue", body="This is the issue body") + Issue(title="This is a new issue", number=XXX) + +Create issue with labels +------------------------ + +.. code-block:: python + + >>> repo = g.get_repo("PyGithub/PyGithub") + >>> label = repo.get_label("My Label") + >>> repo.create_issue(title="This is a new issue", labels=[label]) + Issue(title="This is a new issue", number=XXX) + +Create issue with assignee +-------------------------- + +.. code-block:: python + + >>> repo = g.get_repo("PyGithub/PyGithub") + >>> repo.create_issue(title="This is a new issue", assignee="github-username") + Issue(title="This is a new issue", number=XXX) + +Create issue with milestone +--------------------------- + +.. code-block:: python + + >>> repo = g.get_repo("PyGithub/PyGithub") + >>> milestone = repo.create_milestone("New Issue Milestone") + >>> repo.create_issue(title="This is a new issue", milestone=milestone) + Issue(title="This is a new issue", number=XXX) diff --git a/doc/examples/Milestone.rst b/doc/examples/Milestone.rst new file mode 100644 index 0000000000..0649e55cd7 --- /dev/null +++ b/doc/examples/Milestone.rst @@ -0,0 +1,42 @@ +Milestone +========== + +Get Milestone list +------------------ + +.. code-block:: python + + >>> repo = g.get_repo('PyGithub/PyGithub') + >>> open_milestones = repo.get_milestones(state='open') + >>> for milestone in open_milestones: + ... print(milestone) + ... + Milestone(number=1) + Milestone(number=2) + +Get Milestone +------------- + +.. code-block:: python + + >>> repo = g.get_repo('PyGithub/PyGithub') + >>> repo.get_milestone(number=1) + Milestone(number=1) + +Create Milestone +---------------- + +.. code-block:: python + + >>> repo = g.get_repo('PyGithub/PyGithub') + >>> repo.create_milestone(title='New Milestone') + Milestone(number=1) + +Create Milestone with State and Description +------------------------------------------- + +.. code-block:: python + + >>> repo = g.get_repo('PyGithub/PyGithub') + >>> repo.create_milestone(title='New Milestone', state='open', description='Milestone description') + Milestone(number=1)