summaryrefslogtreecommitdiff
path: root/docs/gl_objects/labels.rst
diff options
context:
space:
mode:
authorGauvain Pocentek <gauvain@pocentek.net>2018-05-20 09:01:05 +0200
committerGauvain Pocentek <gauvain@pocentek.net>2018-05-20 09:01:05 +0200
commit5292ffb366f97e4dc611dfd49a1dca7d1e934f4c (patch)
tree220659b39e0e5384504de3c63bbff003ad50eec2 /docs/gl_objects/labels.rst
parent2c342372814bbac2203d7b4c0f2cd32541bab979 (diff)
downloadgitlab-5292ffb366f97e4dc611dfd49a1dca7d1e934f4c.tar.gz
[docs] Rework the examples pages
* Get rid of the .py files and bring all the python examples in the RST files * Fix a few things
Diffstat (limited to 'docs/gl_objects/labels.rst')
-rw-r--r--docs/gl_objects/labels.rst56
1 files changed, 23 insertions, 33 deletions
diff --git a/docs/gl_objects/labels.rst b/docs/gl_objects/labels.rst
index 3c8034d..1c98971 100644
--- a/docs/gl_objects/labels.rst
+++ b/docs/gl_objects/labels.rst
@@ -11,50 +11,40 @@ Reference
+ :class:`gitlab.v4.objects.ProjectLabelManager`
+ :attr:`gitlab.v4.objects.Project.labels`
-* v3 API:
-
- + :class:`gitlab.v3.objects.ProjectLabel`
- + :class:`gitlab.v3.objects.ProjectLabelManager`
- + :attr:`gitlab.v3.objects.Project.labels`
- + :attr:`gitlab.Gitlab.project_labels`
-
* GitLab API: https://docs.gitlab.com/ce/api/labels.html
Examples
--------
-List labels for a project:
-
-.. literalinclude:: labels.py
- :start-after: # list
- :end-before: # end list
-
-Get a single label:
+List labels for a project::
-.. literalinclude:: labels.py
- :start-after: # get
- :end-before: # end get
+ labels = project.labels.list()
-Create a label for a project:
+Create a label for a project::
-.. literalinclude:: labels.py
- :start-after: # create
- :end-before: # end create
+ label = project.labels.create({'name': 'foo', 'color': '#8899aa'})
-Update a label for a project:
+Update a label for a project::
-.. literalinclude:: labels.py
- :start-after: # update
- :end-before: # end update
+ # change the name of the label:
+ label.new_name = 'bar'
+ label.save()
+ # change its color:
+ label.color = '#112233'
+ label.save()
-Delete a label for a project:
+Delete a label for a project::
-.. literalinclude:: labels.py
- :start-after: # delete
- :end-before: # end delete
+ project.labels.delete(label_id)
+ # or
+ label.delete()
-Managing labels in issues and merge requests:
+Manage labels in issues and merge requests::
-.. literalinclude:: labels.py
- :start-after: # use
- :end-before: # end 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()