Add example for Pull Request comments to documentation (#2390)

chouetz · web-flow · commit c2f12bdc0998 · 2023-05-23T15:37:23.000+02:00
diff --git a/doc/examples/PullRequest.rst b/doc/examples/PullRequest.rst
@@ -43,3 +43,20 @@ Get Pull Requests by Query
     861
     875
     876
+    
+Add and modify Pull Request comment
+-----------------------------------
+
+.. code-block:: python
+
+    >>> repo = g.get_repo("PyGithub/PyGithub")
+    >>> pr = repo.get_pull(2390)
+    >>> last_commit = pr.get_commits()[pr.commits - 1]
+    >>> comment = pr.create_comment("This is a comment", last_commit, "file.txt", 0)
+    >>> comment
+    PullRequestComment(user=NamedUser(login="anonymous"), id=1057297855)
+    >>> comment.body
+    'This is a comment'
+    >>> comment.edit("This is a modified comment")
+    >>> comment.body
+    'This is a modified comment'

Original file line number	Diff line number	Diff line change
`@@ -43,3 +43,20 @@ Get Pull Requests by Query`
`43`	`43`	`861`
`44`	`44`	`875`
`45`	`45`	`876`
	`46`	`+`
	`47`	`+Add and modify Pull Request comment`
	`48`	`+-----------------------------------`
	`49`	`+`
	`50`	`+.. code-block:: python`
	`51`	`+`
	`52`	`+ >>> repo = g.get_repo("PyGithub/PyGithub")`
	`53`	`+ >>> pr = repo.get_pull(2390)`
	`54`	`+ >>> last_commit = pr.get_commits()[pr.commits - 1]`
	`55`	`+ >>> comment = pr.create_comment("This is a comment", last_commit, "file.txt", 0)`
	`56`	`+ >>> comment`
	`57`	`+ PullRequestComment(user=NamedUser(login="anonymous"), id=1057297855)`
	`58`	`+ >>> comment.body`
	`59`	`+ 'This is a comment'`
	`60`	`+ >>> comment.edit("This is a modified comment")`
	`61`	`+ >>> comment.body`
	`62`	`+ 'This is a modified comment'`