Skip to content

Commit

Permalink
add a note about project search API
Browse files Browse the repository at this point in the history
  • Loading branch information
Gauvain Pocentek committed Mar 12, 2016
1 parent e46c188 commit e48e4ac
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions gitlab/objects.py
Expand Up @@ -1516,6 +1516,16 @@ class ProjectManager(BaseManager):
def search(self, query, **kwargs):
"""Search projects by name.
.. note::
The search is only performed on the project name (not on the
namespace or the description). To perform a smarter search, use the
``search`` argument of the ``list()`` method:
.. code-block:: python
gl.projects.list(search=your_search_string)
Args:
query (str): The query string to send to GitLab for the search.
all (bool): If True, return all the items, without pagination
Expand Down

0 comments on commit e48e4ac

Please sign in to comment.