diff options
Diffstat (limited to 'docs/data.adoc')
| -rw-r--r-- | docs/data.adoc | 21 |
1 files changed, 21 insertions, 0 deletions
diff --git a/docs/data.adoc b/docs/data.adoc new file mode 100644 index 0000000..b267959 --- /dev/null +++ b/docs/data.adoc @@ -0,0 +1,21 @@ += data.py + +== PullRequest + +References a pull request. + +This class is a `QObject` with the following properties: + +`number` :: (_int_)Pull request number. +`title` :: (_str_) Title of the pull request. +`state` :: (_str_) State of the pull request. This could be one of `open`, `closed` of `draft`. +`url` :: (_str_) Url of the pull request of the form `https://github.com/<user>/<repo>/pull/<number>`. +`body` :: (_str_) Description of the pull request. +`created_at` :: (_datetime_) When the pull requests was created. +`draft` :: (_bool_) If it's a draft pull request. +`username` :: (_str_) Who made the pull request +`reviewers` :: (_list[User]_) All reviewers. +`last_commit` :: (_str_) Sha of the latest commit. +`labels` :: (_list[Label]_) List of labels of the pull request. +`files` :: (_list[ChangedFile]_) List of files that are modified in this pull request. +`reviews` :: (_list[ReviewComment]_) List of reviews. |