[docs] improve the labels usage documentation

Gauvain Pocentek · Gauvain Pocentek · commit 5945537c1578 · 2017-10-08T10:05:16.000+02:00
Closes #329
diff --git a/docs/gl_objects/labels.py b/docs/gl_objects/labels.py
@@ -24,3 +24,13 @@
 # or
 label.delete()
 # end delete
+
+# use
+# Labels are defined as lists in issues and merge requests. The labels must
+# exist.
+issue = p.issues.create({'title': 'issue title',
+                         'description': 'issue description',
+                         'labels': ['foo']})
+issue.labels.append('bar')
+issue.save()
+# end use
diff --git a/docs/gl_objects/labels.rst b/docs/gl_objects/labels.rst
@@ -52,3 +52,9 @@ Delete a label for a project:
 .. literalinclude:: labels.py
    :start-after: # delete
    :end-before: # end delete
+
+Managing labels in issues and merge requests:
+
+.. literalinclude:: labels.py
+   :start-after: # use
+   :end-before: # end use
diff --git a/docs/gl_objects/mrs.py b/docs/gl_objects/mrs.py
@@ -13,7 +13,8 @@
 # create
 mr = project.mergerequests.create({'source_branch': 'cool_feature',
                                    'target_branch': 'master',
-                                   'title': 'merge cool feature'})
+                                   'title': 'merge cool feature',
+                                   'labels': ['label1', 'label2']})
 # end create
 
 # update
diff --git a/docs/gl_objects/projects.py b/docs/gl_objects/projects.py
@@ -384,12 +384,12 @@
 issue.notes.create({
     "body": "See the attached file: {}".format(uploaded_file["markdown"])
 })
-# project file upload markdown
+# end project file upload markdown
 
 # project file upload markdown custom
 uploaded_file = project.upload("filename.txt", filedata="data")
 issue = project.issues.get(issue_id)
 issue.notes.create({
     "body": "See the [attached file]({})".format(uploaded_file["url"])
 })
-# project file upload markdown
+# end project file upload markdown custom
