diff options
author | Gauvain Pocentek <gauvain@pocentek.net> | 2016-11-05 17:15:27 +0100 |
---|---|---|
committer | Gauvain Pocentek <gauvain@pocentek.net> | 2016-11-05 17:15:27 +0100 |
commit | 92180e47f76eaf293728cb1d463f601925404123 (patch) | |
tree | 0dfb03a362ff49aa6a9fec927590938be1145b0a /docs | |
parent | c970a22e933523b02f3536113ed5afc7a7e9ffe5 (diff) | |
download | gitlab-92180e47f76eaf293728cb1d463f601925404123.tar.gz |
Implement merge requests diff support
Diffstat (limited to 'docs')
-rw-r--r-- | docs/gl_objects/mrs.py | 8 | ||||
-rw-r--r-- | docs/gl_objects/mrs.rst | 22 |
2 files changed, 26 insertions, 4 deletions
diff --git a/docs/gl_objects/mrs.py b/docs/gl_objects/mrs.py index 0ef3b87..021338d 100644 --- a/docs/gl_objects/mrs.py +++ b/docs/gl_objects/mrs.py @@ -63,3 +63,11 @@ mr.unsubscribe() # todo mr.todo() # end todo + +# diff list +diffs = mr.diffs.list() +# end diff list + +# diff get +diff = mr.diffs.get(diff_id) +# end diff get diff --git a/docs/gl_objects/mrs.rst b/docs/gl_objects/mrs.rst index 6c83ab7..d6e10d3 100644 --- a/docs/gl_objects/mrs.rst +++ b/docs/gl_objects/mrs.rst @@ -2,10 +2,12 @@ Merge requests ############## -Use :class:`~gitlab.objects.ProjectMergeRequest` objects to manipulate MRs for -projects. The :attr:`gitlab.Gitlab.project_mergerequests` and -:attr:`Project.mergerequests <gitlab.objects.Project.mergerequests>` manager -objects provide helper functions. +You can use merge requests to notify a project that a branch is ready for +merging. The owner of the target projet can accept the merge request. + +* Object class: :class:`~gitlab.objects.ProjectMergeRequest` +* Manager objects: :attr:`gitlab.Gitlab.project_mergerequests`, + :attr:`Project.mergerequests <gitlab.objects.Project.mergerequests>` Examples -------- @@ -89,3 +91,15 @@ Mark a MR as todo: .. literalinclude:: mrs.py :start-after: # todo :end-before: # end todo + +List the diffs for a merge request: + +.. literalinclude:: mrs.py + :start-after: # diff list + :end-before: # end diff list + +Get a diff for a merge request: + +.. literalinclude:: mrs.py + :start-after: # diff get + :end-before: # end diff get |