summaryrefslogtreecommitdiff
path: root/docs/gl_objects
diff options
context:
space:
mode:
authorGauvain Pocentek <gauvain@pocentek.net>2017-10-08 10:05:16 +0200
committerGauvain Pocentek <gauvain@pocentek.net>2017-10-08 10:05:16 +0200
commit5945537c157818483a4a14138619fa6b9341e6b3 (patch)
tree2b1759f7c7e116abbf73795eecd20d5656f777be /docs/gl_objects
parent316754dd8290ee80c8c197eb1eca559fce97792e (diff)
downloadgitlab-5945537c157818483a4a14138619fa6b9341e6b3.tar.gz
[docs] improve the labels usage documentation
Closes #329
Diffstat (limited to 'docs/gl_objects')
-rw-r--r--docs/gl_objects/labels.py10
-rw-r--r--docs/gl_objects/labels.rst6
-rw-r--r--docs/gl_objects/mrs.py3
-rw-r--r--docs/gl_objects/projects.py4
4 files changed, 20 insertions, 3 deletions
diff --git a/docs/gl_objects/labels.py b/docs/gl_objects/labels.py
index 57892b5..a63e295 100644
--- a/docs/gl_objects/labels.py
+++ b/docs/gl_objects/labels.py
@@ -24,3 +24,13 @@ project.labels.delete(label_id)
# 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
index d444217..3c8034d 100644
--- 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
index bc30b43..1e54c80 100644
--- a/docs/gl_objects/mrs.py
+++ b/docs/gl_objects/mrs.py
@@ -13,7 +13,8 @@ mr = project.mergerequests.get(mr_id)
# 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
index 849d6f4..6ef6069 100644
--- a/docs/gl_objects/projects.py
+++ b/docs/gl_objects/projects.py
@@ -384,7 +384,7 @@ issue = project.issues.get(issue_id)
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")
@@ -392,4 +392,4 @@ 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