Merge pull request #1162 from RogerSelwyn/docs_for_query

Add query to the docs, plus minor corrections to docs in query

Author: alejcas

O365/utils/query.py

@@ -39,6 +39,7 @@ def get_filter_by_attribute(self, attribute: str) -> Optional[str]:
         """
         Returns a filter value by attribute name. It will match the attribute to the start of each filter attribute
         and return the first found.
+        
         :param attribute: the attribute you want to search
         :return: The value applied to that attribute or None
         """
@@ -607,11 +608,14 @@ def iterable_operation(self, operation: str, collection: str, filter_instance: C
         """ Performs the provided filter operation on a collection by iterating over it.
 
         For example:
-        q.iterable(
-            operation='any',
-            collection='email_addresses',
-            filter_instance=q.equals('address', '[email protected]')
-        )
+
+        .. code-block:: python
+
+            q.iterable(
+                operation='any',
+                collection='email_addresses',
+                filter_instance=q.equals('address', '[email protected]')
+            )
 
         will transform to a filter such as:
         emailAddresses/any(a:a/address eq '[email protected]')
@@ -753,7 +757,7 @@ def select(self, *attributes: str) -> CompositeFilter:
         """
         Returns a 'select' query param
         This is useful to return a limited set of attributes from a resource or return attributes that are not
-         returned by default by the resource.
+        returned by default by the resource.
 
         :param attributes: a tuple of attribute names to select
         :return: a CompositeFilter instance that can render the OData select operation
@@ -770,8 +774,8 @@ def expand(self, relationship: str, select: Optional[CompositeFilter] = None) ->
         """
         Returns an 'expand' query param
         Important: If the 'expand' is a relationship (e.g. "event" or "attachments"), then the ApiComponent using
-         this query should know how to handle the relationship (e.g. Message knows how to handle attachments,
-         and event (if it's an EventMessage).
+        this query should know how to handle the relationship (e.g. Message knows how to handle attachments,
+        and event (if it's an EventMessage).
         Important: When using expand on multi-value relationships a max of 20 items will be returned.
 
         :param relationship: a relationship that will be expanded

O365/utils/utils.py

@@ -1308,7 +1308,13 @@ def close_group(self):
         return self
 
     def get_filter_by_attribute(self, attribute):
-        """ Returns a filter word applied to an attribute """
+        """
+        Returns a filter value by attribute name. It will match the attribute to the start of each filter attribute
+        and return the first found.
+        
+        :param attribute: the attribute you want to search
+        :return: The value applied to that attribute or None
+        """
 
         attribute = attribute.lower()
 

docs/source/api/utils.rst

@@ -7,5 +7,6 @@ Utils
    :caption: Contents:
 
    utils/attachment
+   utils/query
    utils/token
    utils/utils

docs/source/api/utils/query.rst

@@ -0,0 +1,10 @@
+Query
+-----
+
+.. include:: ../global.rst
+
+.. automodule:: O365.utils.query
+    :members:
+    :undoc-members:
+    :show-inheritance:
+    :member-order: groupwise

docs/source/usage/utils.rst

@@ -6,5 +6,6 @@ Utils
    :maxdepth: 2
    :caption: Contents:
 
+   utils/query
    utils/token
    utils/utils

docs/source/usage/utils/query.rst

@@ -0,0 +1,7 @@
+Query
+=====
+
+Query Builder
+-------------
+
+