Fixed type in docstring for get_query_result (#425)

Updated parameter `selector` from str to dict in docstring

Author: emlaver

CHANGES.md

@@ -1,6 +1,7 @@
 # Unreleased
 
 - [IMPROVED] Updated `Getting started` section with a `get_query_result` example. 
+- [FIXED] Fixed parameter type of `selector` in docstring.
 
 # 2.11.0 (2019-01-21)
 

src/cloudant/database.py

@@ -1,5 +1,5 @@
 #!/usr/bin/env python
-# Copyright (C) 2015, 2018 IBM Corp. All rights reserved.
+# Copyright (C) 2015, 2019 IBM Corp. All rights reserved.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -1112,7 +1112,7 @@ def get_query_result(self, selector, fields=None, raw_result=False,
         For more detail on slicing and iteration, refer to the
         :class:`~cloudant.result.QueryResult` documentation.
 
-        :param str selector: Dictionary object describing criteria used to
+        :param dict selector: Dictionary object describing criteria used to
             select documents.
         :param list fields: A list of fields to be returned by the query.
         :param bool raw_result: Dictates whether the query result is returned

src/cloudant/query.py

@@ -1,5 +1,5 @@
 #!/usr/bin/env python
-# Copyright (C) 2015, 2018 IBM. All rights reserved.
+# Copyright (C) 2015, 2019 IBM. All rights reserved.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -75,7 +75,7 @@ class Query(dict):
     :param int limit: Maximum number of results returned.
     :param int r: Read quorum needed for the result.  Each document is read from
         at least 'r' number of replicas before it is returned in the results.
-    :param str selector: Dictionary object describing criteria used to select
+    :param dict selector: Dictionary object describing criteria used to select
         documents.
     :param int skip: Skip the first 'n' results, where 'n' is the value
         specified.
@@ -137,7 +137,7 @@ def __call__(self, **kwargs):
         :param int r: Read quorum needed for the result.  Each document is read
             from at least 'r' number of replicas before it is returned in the
             results.
-        :param str selector: Dictionary object describing criteria used to
+        :param dict selector: Dictionary object describing criteria used to
             select documents.
         :param int skip: Skip the first 'n' results, where 'n' is the value
             specified.
@@ -201,7 +201,7 @@ def custom_result(self, **options):
         :param int r: Read quorum needed for the result.  Each document is read
             from at least 'r' number of replicas before it is returned in the
             results.
-        :param str selector: Dictionary object describing criteria used to
+        :param dict selector: Dictionary object describing criteria used to
             select documents.
         :param list sort: A list of fields to sort by.  Optionally the list can
             contain elements that are single member dictionary structures that

src/cloudant/result.py

@@ -1,5 +1,5 @@
 #!/usr/bin/env python
-# Copyright (C) 2015, 2018 IBM Corp. All rights reserved.
+# Copyright (C) 2015, 2019 IBM Corp. All rights reserved.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -454,7 +454,7 @@ class QueryResult(Result):
     :param int r: Read quorum needed for the result.  Each document is read
         from at least 'r' number of replicas before it is returned in the
         results.
-    :param str selector: Dictionary object describing criteria used to
+    :param dict selector: Dictionary object describing criteria used to
         select documents.
     :param list sort: A list of fields to sort by.  Optionally the list can
         contain elements that are single member dictionary structures that