From a50e50d724aa3ebd43663ca4d5061fb54e4fcbbe Mon Sep 17 00:00:00 2001
From: Christophe Troestler <Christophe.Troestler@umons.ac.be>
Date: Tue, 24 Oct 2023 18:25:30 +0200
Subject: [PATCH] Document the PullRequest number field

Fixes https://github.com/XAMPPRocky/octocrab/issues/473
---
 src/models/pulls.rs | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/src/models/pulls.rs b/src/models/pulls.rs
index 555523e7..71600cc1 100644
--- a/src/models/pulls.rs
+++ b/src/models/pulls.rs
@@ -25,6 +25,8 @@ pub struct PullRequest {
     pub comments_url: Option<Url>,
     #[serde(skip_serializing_if = "Option::is_none")]
     pub statuses_url: Option<Url>,
+    /// The pull request number.  Note that GitHub's REST API
+    /// considers every pull-request an issue with the same number.
     pub number: u64,
     #[serde(skip_serializing_if = "Option::is_none")]
     pub state: Option<IssueState>,