From b8841418913eeb78fd561d8ca0d107da458b3f9a Mon Sep 17 00:00:00 2001
From: Tomas Kopecek <tkopecek@redhat.com>
Date: Feb 12 2020 09:44:56 +0000
Subject: PR#2000: hub: improve listBTypes() API documentation


Merges #2000
https://pagure.io/koji/pull-request/2000

---

diff --git a/hub/kojihub.py b/hub/kojihub.py
index 5a0b869..4eb7f84 100644
--- a/hub/kojihub.py
+++ b/hub/kojihub.py
@@ -4355,15 +4355,12 @@ def get_build_type(buildInfo, strict=False):
 def list_btypes(query=None, queryOpts=None):
     """List btypes matching query
 
-    Options:
-        query - dictionary specifying selection parameters
-        queryOpts - dictionary specifying other query options
-
-    Supported query parameters:
-        name - select btypes by name
-        id - select btypes by id
-
-    If query is None, then all btypes are returned
+    :param dict query: Select a particular btype by "name" or "id".
+                       Example: {"name": "image"}.
+                       If this parameter is None (default), Koji returns all
+                       btypes.
+    :param dict queryOpts: additional options for this query.
+    :returns: a list of btype dicts.
     """
     if query is None:
         query = {}