FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

document namespaces API · python-gitlab/python-gitlab@1f52cd2 · GitHub

  1. python-gitlab
  2. python-gitlab

Repository navigation

Commit 1f52cd2

Browse files
Gauvain Pocentek
committed
document namespaces API
1 parent e0f2290 commit 1f52cd2

4 files changed

Lines changed: 30 additions & 1 deletion

File tree

‎docs/api-objects.rst‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ API objects manipulation
99
gl_objects/commits
1010
gl_objects/groups
1111
gl_objects/issues
12+
gl_objects/namespaces
1213
gl_objects/projects
1314
gl_objects/runners
1415
gl_objects/users

‎docs/gl_objects/namespaces.py‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# list
2+
namespaces = gl.namespaces.list()
3+
# end list
4+
5+
# search
6+
namespaces = gl.namespaces.list(search='foo')
7+
# end search

‎docs/gl_objects/namespaces.rst‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
##########
2+
Namespaces
3+
##########
4+
5+
Use :class:`~gitlab.objects.Namespace` objects to manipulate namespaces. The
6+
:attr:`gitlab.Gitlab.namespaces` manager objects provides helper functions.
7+
8+
Examples
9+
========
10+
11+
List namespaces:
12+
13+
.. literalinclude:: namespaces.py
14+
:start-after: # list
15+
:end-before: # end list
16+
17+
Search namespaces:
18+
19+
.. literalinclude:: namespaces.py
20+
:start-after: # search
21+
:end-before: # end search

‎docs/gl_objects/runners.rst‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ Examples
1313

1414
Use the ``list()`` and ``all()`` methods to list runners.
1515

16-
The ``all()`` method accepts a ``scope`` parameter to filter the list. Allowed
16+
The ``all()`` method accepts a ``scope`` parameter to filter the list. Allowed
1717
values for this parameter are ``specific``, ``shared``, ``active``, ``paused``
1818
and ``online``.
1919

0 commit comments

Comments
 (0)
Back | FazBrowse Home | New Git URL