Skip to content

Commit e9506d1

Browse files
author
Gauvain Pocentek
committed
Minor doc updates
1 parent 4d4c8ad commit e9506d1

File tree

5 files changed

+12
-6
lines changed

5 files changed

+12
-6
lines changed

RELEASE_NOTES.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@ Changes from 1.4 to 1.5
1414
configuration, epics.
1515
* The ``GetFromListMixin`` class has been removed. The ``get()`` method is not
1616
available anymore for the following managers:
17+
1718
- UserKeyManager
1819
- DeployKeyManager
1920
- GroupAccessRequestManager
@@ -27,6 +28,7 @@ Changes from 1.4 to 1.5
2728
- ProjectPipelineJobManager
2829
- ProjectAccessRequestManager
2930
- TodoManager
31+
3032
* ``ProjectPipelineJob`` do not heritate from ``ProjectJob`` anymore and thus
3133
can only be listed.
3234

docs/api-usage.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ python-gitlab supports both GitLab v3 and v4 APIs. To use the v3 make sure to
77
.. note::
88

99
To use the v3 make sure to install python-gitlab 1.4. Only the v4 API is
10-
documented here. See the documentation of earlier version for the v3 API.
10+
documented here. See the documentation of earlier versions for the v3 API.
1111

1212
``gitlab.Gitlab`` class
1313
=======================
@@ -88,7 +88,7 @@ Examples:
8888
You can list the mandatory and optional attributes for object creation and
8989
update with the manager's ``get_create_attrs()`` and ``get_update_attrs()``
9090
methods. They return 2 tuples, the first one is the list of mandatory
91-
attributes, the second one the list of optional attribute:
91+
attributes, the second one is the list of optional attribute:
9292

9393
.. code-block:: python
9494
@@ -206,7 +206,7 @@ through a large number of items:
206206
for item in items:
207207
print(item.attributes)
208208
209-
The generator exposes extra listing information as received by the server:
209+
The generator exposes extra listing information as received from the server:
210210

211211
* ``current_page``: current page number (first page is 1)
212212
* ``prev_page``: if ``None`` the current page is the first one
@@ -249,7 +249,7 @@ properly closed when you exit a ``with`` block:
249249
.. warning::
250250

251251
The context manager will also close the custom ``Session`` object you might
252-
have used to build a ``Gitlab`` instance.
252+
have used to build the ``Gitlab`` instance.
253253

254254
Proxy configuration
255255
-------------------

docs/gl_objects/commits.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -85,7 +85,7 @@ Reference
8585

8686
+ :class:`gitlab.v4.objects.ProjectCommitComment`
8787
+ :class:`gitlab.v4.objects.ProjectCommitCommentManager`
88-
+ :attr:`gitlab.v4.objects.Commit.comments`
88+
+ :attr:`gitlab.v4.objects.ProjectCommit.comments`
8989

9090
* GitLab API: https://docs.gitlab.com/ce/api/commits.html
9191

@@ -116,7 +116,7 @@ Reference
116116

117117
+ :class:`gitlab.v4.objects.ProjectCommitStatus`
118118
+ :class:`gitlab.v4.objects.ProjectCommitStatusManager`
119-
+ :attr:`gitlab.v4.objects.Commit.statuses`
119+
+ :attr:`gitlab.v4.objects.ProjectCommit.statuses`
120120

121121
* GitLab API: https://docs.gitlab.com/ce/api/commits.html
122122

docs/gl_objects/issues.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
.. _issues_examples:
2+
13
######
24
Issues
35
######

docs/gl_objects/mrs.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
.. _merge_requests_examples:
2+
13
##############
24
Merge requests
35
##############

0 commit comments

Comments
 (0)