docs: update docstrings

Author: matmoncon

pyneo4j_ogm/fields/property_options.py

@@ -18,11 +18,11 @@ def WithOptions(
 
     Args:
         property_type (Type[T]): The property type to return for the model field.
-        range_index (bool, optional): Whether the property should have a `RANGE` index or not. Defaults to False.
-        text_index (bool, optional): Whether the property should have a `TEXT` index or not. Defaults to False.
-        point_index (bool, optional): Whether the property should have a `POINT` index or not. Defaults to False.
+        range_index (bool, optional): Whether the property should have a `RANGE` index or not. Defaults to `False`.
+        text_index (bool, optional): Whether the property should have a `TEXT` index or not. Defaults to `False`.
+        point_index (bool, optional): Whether the property should have a `POINT` index or not. Defaults to `False`.
         unique (bool, optional): Whether a `UNIQUENESS` constraint should be created for the property.
-            Defaults to False.
+            Defaults to `False`.
 
     Returns:
         Type[T]: A subclass of the provided type with extra attributes.

pyneo4j_ogm/logger.py

@@ -2,8 +2,8 @@
 Logging configuration for pyneo4j-ogm
 
 Logging is controlled by two environment variables:
-- PYNEO4J_OGM_LOG_LEVEL: the log level to use (default: WARNING)
-- PYNEO4J_OGM_ENABLE_LOGGING: whether to enable logging (default: True)
+- PYNEO4J_OGM_LOG_LEVEL: the log level to use. Defaults to `WARNING`.
+- PYNEO4J_OGM_ENABLE_LOGGING: whether to enable logging. Defaults to `True`.
 """
 import logging
 from os import environ

pyneo4j_ogm/queries/operators.py

@@ -109,9 +109,9 @@ def normalize_expressions(
         Normalizes and formats the provided expressions into usable expressions for the builder.
 
         Args:
-            expressions (Union[Dict[str, Any], List[Any]]): The expressions to normalize
+            expressions (Union[Dict[str, Any], List[Any]]): The expressions to normalize.
             level (int, optional): The recursion depth level. Should not be modified outside the
-                function itself. Defaults to 0.
+                function itself. Defaults to `0`.
 
         Returns:
             Union[Dict[str, Any], List[Any]]: The normalized expressions.
@@ -179,7 +179,7 @@ def remove_invalid_expressions(self, expressions: Dict[str, Any], level: int = 0
         Args:
             expressions (Dict[str, Any]): The expression to check.
             level (int, optional): The recursion depth level. Should not be modified outside the
-                function itself. Defaults to 0.
+                function itself. Defaults to `0`.
         """
         operators_to_remove: List[str] = []
 

pyneo4j_ogm/queries/query_builder.py

@@ -67,7 +67,7 @@ def node_filters(self, filters: NodeFilters, ref: str = "n") -> None:
 
         Args:
             filters (Dict[str, Any]): The filters to build.
-            ref (str, optional): The reference to the node. Defaults to "n".
+            ref (str, optional): The reference to the node. Defaults to `'n'`.
         """
         logger.debug("Building node filters %s", filters)
         self._operator_builder.ref = ref
@@ -94,7 +94,7 @@ def relationship_filters(self, filters: RelationshipFilters, ref: str = "r") ->
 
         Args:
             filters (Dict[str, Any]): The filters to build.
-            ref (str, optional): The reference to the relationship. Defaults to "r".
+            ref (str, optional): The reference to the relationship. Defaults to `'r'`.
         """
         logger.debug("Building relationship filters %s", filters)
         self._operator_builder.ref = ref
@@ -123,8 +123,8 @@ def relationship_property_filters(
 
         Args:
             filters (Dict[str, Any]): The filters to build.
-            ref (str, optional): The reference to the relationship. Defaults to "r".
-            node_ref (str, optional): The reference to the node. Defaults to "end".
+            ref (str, optional): The reference to the relationship. Defaults to `'r'`.
+            node_ref (str, optional): The reference to the node. Defaults to `'end'`.
         """
         logger.debug("Building relationship property filters %s", filters)
         self._operator_builder.reset_state()
@@ -160,9 +160,9 @@ def multi_hop_filters(
 
         Args:
             filters (Dict[str, Any]): The filters to build.
-            start_ref (str, optional): The reference to the start node. Defaults to "n".
-            end_ref (str, optional): The reference to the end node. Defaults to "m".
-            rel_ref (str, optional): The reference to the relationship. Defaults to "r".
+            start_ref (str, optional): The reference to the start node. Defaults to `'n'`.
+            end_ref (str, optional): The reference to the end node. Defaults to `'m'`.
+            rel_ref (str, optional): The reference to the relationship. Defaults to `'r'`.
         """
         logger.debug("Building multi hop filters %s", filters)
         self._operator_builder.ref = start_ref
@@ -237,7 +237,7 @@ def query_options(self, options: QueryOptions, ref: str = "n") -> None:
 
         Args:
             options (QueryOptions): The options to build.
-            ref (str, optional): The reference to the node or relationship. Defaults to "n".
+            ref (str, optional): The reference to the node or relationship. Defaults to `'n'`.
         """
         logger.debug("Building query options %s", options)
 
@@ -305,16 +305,16 @@ def relationship_match(
 
         Args:
             type_ (str): The type of the relationship.
-            ref (str, optional): The reference to the relationship. Defaults to "r".
-            start_node_ref (Optional[str], optional): The reference to the start node. Defaults to None.
-            start_node_labels (Optional[List[str]], optional): The labels of the start node. Defaults to None.
-            end_node_ref (Optional[str], optional): The reference to the end node. Defaults to None.
-            end_node_labels (Optional[List[str]], optional): The labels of the end node. Defaults to None.
-            min_hops (Optional[Union[int, str]], optional): The minimum number of hops. Defaults to None.
-            max_hops (Optional[Union[int, str]], optional): The maximum number of hops. Defaults to None.
+            ref (str, optional): The reference to the relationship. Defaults to `'r'`.
+            start_node_ref (Optional[str], optional): The reference to the start node. Defaults to `None`.
+            start_node_labels (Optional[List[str]], optional): The labels of the start node. Defaults to `None`.
+            end_node_ref (Optional[str], optional): The reference to the end node. Defaults to `None`.
+            end_node_labels (Optional[List[str]], optional): The labels of the end node. Defaults to `None`.
+            min_hops (Optional[Union[int, str]], optional): The minimum number of hops. Defaults to `None`.
+            max_hops (Optional[Union[int, str]], optional): The maximum number of hops. Defaults to `None`.
 
         Raises:
-            InvalidRelationshipHops: Raised when the min_hops or max_hops are invalid.
+            InvalidRelationshipHops: If the min_hops or max_hops are invalid.
 
         Returns:
             str: The relationship to match.
@@ -374,7 +374,7 @@ def build_projections(
         Builds a projection which only returns the node properties defined in the projection.
 
         Args:
-            ref (str): The reference to the node. Defaults to "n".
+            ref (str): The reference to the node. Defaults to `'n'`.
             projections (Dict[str, str]): The projections to build.
         """
         if not isinstance(projections, dict):

pyneo4j_ogm/queries/validators.py

@@ -295,7 +295,7 @@ class MultiHopNodeModel(BaseModel):
 
     class Config:
         """
-        Pydantic configuration
+        Pydantic configuration.
         """
 
         extra = Extra.allow
@@ -319,7 +319,7 @@ class MultiHopFiltersModel(BaseModel):
 
     class Config:
         """
-        Pydantic configuration
+        Pydantic configuration.
         """
 
         extra = Extra.allow