#2000 hub: improve listBTypes() API documentation
Merged 5 months ago by tkopecek. Opened 5 months ago by ktdreyer.
ktdreyer/koji api-doc-listbtypes  into  master

file modified
+6 -9

@@ -4355,15 +4355,12 @@ 

  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 = {}

Reformat this text to match Sphinx's conventions. This makes it easier for developers to read this documentation.

Commit b884141 fixes this pull-request

Pull-Request has been merged by tkopecek

5 months ago
Metadata