document namespaces API

python-gitlab · Aug 4, 2016 · 1f52cd2 · 1f52cd2
1 parent e0f2290
commit 1f52cd2
Show file tree

Hide file tree

Showing 4 changed files with 30 additions and 1 deletion.
diff --git a/docs/api-objects.rst b/docs/api-objects.rst
@@ -9,6 +9,7 @@ API objects manipulation
    gl_objects/commits
    gl_objects/groups
    gl_objects/issues
+   gl_objects/namespaces
    gl_objects/projects
    gl_objects/runners
    gl_objects/users
diff --git a/docs/gl_objects/namespaces.py b/docs/gl_objects/namespaces.py
@@ -0,0 +1,7 @@
+# list
+namespaces = gl.namespaces.list()
+# end list
+
+# search
+namespaces = gl.namespaces.list(search='foo')
+# end search
diff --git a/docs/gl_objects/namespaces.rst b/docs/gl_objects/namespaces.rst
@@ -0,0 +1,21 @@
+##########
+Namespaces
+##########
+
+Use :class:`~gitlab.objects.Namespace` objects to manipulate namespaces. The
+:attr:`gitlab.Gitlab.namespaces` manager objects provides helper functions.
+
+Examples
+========
+
+List namespaces:
+
+.. literalinclude:: namespaces.py
+   :start-after: # list
+   :end-before: # end list
+
+Search namespaces:
+
+.. literalinclude:: namespaces.py
+   :start-after: # search
+   :end-before: # end search
diff --git a/docs/gl_objects/runners.rst b/docs/gl_objects/runners.rst
@@ -13,7 +13,7 @@ Examples
 
 Use the ``list()`` and ``all()`` methods to list runners.
 
- The ``all()`` method accepts a ``scope`` parameter to filter the list. Allowed
+The ``all()`` method accepts a ``scope`` parameter to filter the list. Allowed
 values for this parameter are ``specific``, ``shared``, ``active``, ``paused``
 and ``online``.