summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorGauvain Pocentek <gauvain@pocentek.net>2018-08-25 15:46:27 +0200
committerGauvain Pocentek <gauvain@pocentek.net>2018-08-25 15:46:27 +0200
commite9506d15a971888a9af72b37d3e7dbce55e49126 (patch)
treeb1818a05899b7a70ca19675a2ae0b7241d30c635
parent4d4c8ad1f75142fa1ca6ccd037e9d501ca873b60 (diff)
downloadgitlab-e9506d15a971888a9af72b37d3e7dbce55e49126.tar.gz
Minor doc updates
-rw-r--r--RELEASE_NOTES.rst2
-rw-r--r--docs/api-usage.rst8
-rw-r--r--docs/gl_objects/commits.rst4
-rw-r--r--docs/gl_objects/issues.rst2
-rw-r--r--docs/gl_objects/mrs.rst2
5 files changed, 12 insertions, 6 deletions
diff --git a/RELEASE_NOTES.rst b/RELEASE_NOTES.rst
index 9e9fd8c..ac8daeb 100644
--- a/RELEASE_NOTES.rst
+++ b/RELEASE_NOTES.rst
@@ -14,6 +14,7 @@ Changes from 1.4 to 1.5
configuration, epics.
* The ``GetFromListMixin`` class has been removed. The ``get()`` method is not
available anymore for the following managers:
+
- UserKeyManager
- DeployKeyManager
- GroupAccessRequestManager
@@ -27,6 +28,7 @@ Changes from 1.4 to 1.5
- ProjectPipelineJobManager
- ProjectAccessRequestManager
- TodoManager
+
* ``ProjectPipelineJob`` do not heritate from ``ProjectJob`` anymore and thus
can only be listed.
diff --git a/docs/api-usage.rst b/docs/api-usage.rst
index ede2d47..fa6e0b0 100644
--- a/docs/api-usage.rst
+++ b/docs/api-usage.rst
@@ -7,7 +7,7 @@ python-gitlab supports both GitLab v3 and v4 APIs. To use the v3 make sure to
.. note::
To use the v3 make sure to install python-gitlab 1.4. Only the v4 API is
- documented here. See the documentation of earlier version for the v3 API.
+ documented here. See the documentation of earlier versions for the v3 API.
``gitlab.Gitlab`` class
=======================
@@ -88,7 +88,7 @@ Examples:
You can list the mandatory and optional attributes for object creation and
update with the manager's ``get_create_attrs()`` and ``get_update_attrs()``
methods. They return 2 tuples, the first one is the list of mandatory
-attributes, the second one the list of optional attribute:
+attributes, the second one is the list of optional attribute:
.. code-block:: python
@@ -206,7 +206,7 @@ through a large number of items:
for item in items:
print(item.attributes)
-The generator exposes extra listing information as received by the server:
+The generator exposes extra listing information as received from the server:
* ``current_page``: current page number (first page is 1)
* ``prev_page``: if ``None`` the current page is the first one
@@ -249,7 +249,7 @@ properly closed when you exit a ``with`` block:
.. warning::
The context manager will also close the custom ``Session`` object you might
- have used to build a ``Gitlab`` instance.
+ have used to build the ``Gitlab`` instance.
Proxy configuration
-------------------
diff --git a/docs/gl_objects/commits.rst b/docs/gl_objects/commits.rst
index f662fcb..662d9c3 100644
--- a/docs/gl_objects/commits.rst
+++ b/docs/gl_objects/commits.rst
@@ -85,7 +85,7 @@ Reference
+ :class:`gitlab.v4.objects.ProjectCommitComment`
+ :class:`gitlab.v4.objects.ProjectCommitCommentManager`
- + :attr:`gitlab.v4.objects.Commit.comments`
+ + :attr:`gitlab.v4.objects.ProjectCommit.comments`
* GitLab API: https://docs.gitlab.com/ce/api/commits.html
@@ -116,7 +116,7 @@ Reference
+ :class:`gitlab.v4.objects.ProjectCommitStatus`
+ :class:`gitlab.v4.objects.ProjectCommitStatusManager`
- + :attr:`gitlab.v4.objects.Commit.statuses`
+ + :attr:`gitlab.v4.objects.ProjectCommit.statuses`
* GitLab API: https://docs.gitlab.com/ce/api/commits.html
diff --git a/docs/gl_objects/issues.rst b/docs/gl_objects/issues.rst
index 009bdf2..12df90b 100644
--- a/docs/gl_objects/issues.rst
+++ b/docs/gl_objects/issues.rst
@@ -1,3 +1,5 @@
+.. _issues_examples:
+
######
Issues
######
diff --git a/docs/gl_objects/mrs.rst b/docs/gl_objects/mrs.rst
index a2aeff1..b3b5e07 100644
--- a/docs/gl_objects/mrs.rst
+++ b/docs/gl_objects/mrs.rst
@@ -1,3 +1,5 @@
+.. _merge_requests_examples:
+
##############
Merge requests
##############