more docs fixes

Author: mattkjames7

docs/reference/gqlalchemy/models.md

@@ -173,6 +173,9 @@ def parse_obj(cls, obj)
 Used to convert a dictionary object into the appropriate
 GraphObject.
 
+Compatibility note: `parse_obj` is retained for backward compatibility.
+For Pydantic v2-style usage, prefer `model_validate`.
+
 ## NodeMetaclass Objects
 
 ```python

docs/reference/gqlalchemy/query_builders/memgraph_query_builder.md

@@ -79,7 +79,7 @@ Cypher query defining the MATCH clause which selects the nodes and relationships
 **Arguments**:
 
 - `procedure` - A string representing the name of the procedure in the
-  format `query_module.procedure`.
+  format ``query_module.procedure``.
 - `arguments` - A string representing the arguments of the procedure in
   text format.
 - `node_labels` - Either a string, which is then used as the label for all nodes, or
@@ -92,18 +92,32 @@ Cypher query defining the MATCH clause which selects the nodes and relationships
 
 **Returns**:
 
-  A `DeclarativeBase` instance for constructing queries.
+  A ``DeclarativeBase`` instance for constructing queries.
 
 
 **Examples**:
 
-- `Python` - `call('export_util.json', '/home/user', "LABEL", ["TYPE1", "TYPE2"]).execute()`
-- `query_module.procedure`0 - `query_module.procedure`1
+  Python:
+        ```python
+        call('export_util.json', '/home/user', "LABEL", ["TYPE1", "TYPE2"]).execute()
+        ```
+  Cypher:
+        ```cypher
+        MATCH p=(a)-[:TYPE1 | :TYPE2]->(b) WHERE (a:LABEL) AND (b:LABEL)
+        WITH project(p) AS graph CALL export_util.json(graph, '/home/user')
+        ```
 
   or
 
-- `Python` - `query_module.procedure`3
-- `query_module.procedure`0 - `query_module.procedure`5
+  Python:
+        ```python
+        call('export_util.json', '/home/user', subgraph_path="(:LABEL)-[:TYPE]->(:LABEL)").execute()
+        ```
+  Cypher:
+        ```cypher
+        MATCH p=(:LABEL)-[:TYPE1]->(:LABEL) WITH project(p) AS graph
+        CALL export_util.json(graph, '/home/user')
+        ```
 
 ## ProjectPartialQuery Objects
 

docs/reference/gqlalchemy/transformations/importing/graph_importer.md

@@ -37,7 +37,11 @@ Gets cypher queries using the underlying translator and then inserts all queries
 def translate_dot_file(path: str) -> None
 ```
 
-Parses a DOT file to a NetworkX graph and imports it to Memgraph.
+Parses a DOT file to a NetworkX graph and imports it to Memgraph. This method is available when ``graph_type="NX"``
+
+**Arguments**:
+
+  - ``path`` - Path to a DOT file.
 
 #### translate\_dot\_data
 
@@ -47,3 +51,7 @@ def translate_dot_data(dot_data: str) -> None
 
 Parses DOT content to a NetworkX graph and imports it to Memgraph.
 
+**Arguments**:
+
+  - ``dot_data`` - Raw DOT graph content.
+

docs/reference/gqlalchemy/vendors/memgraph.md

@@ -413,7 +413,7 @@ after significant changes to the graph structure or data.
 
 **Arguments**:
 
-- `labels` - Optional list of labels to delete statistics for.
+  labels ``_Optional[List[str]]_``:  Optional list of labels to delete statistics for.
   If None, deletes statistics for all labels.
 
 

gqlalchemy/models.py

@@ -512,6 +512,9 @@ def model_validate(cls, obj, *args, **kwargs):
     def parse_obj(cls, obj):
         """Used to convert a dictionary object into the appropriate
         GraphObject.
+
+        Compatibility note: `parse_obj` is retained for backward compatibility.
+        For Pydantic v2-style usage, prefer `model_validate`.
         """
         return cls.model_validate(obj)
 

gqlalchemy/query_builders/memgraph_query_builder.py

@@ -139,7 +139,7 @@ def call(
 
         Args:
             procedure: A string representing the name of the procedure in the
-              format `query_module.procedure`.
+              format ``query_module.procedure``.
             arguments: A string representing the arguments of the procedure in
               text format.
             node_labels: Either a string, which is then used as the label for all nodes, or
@@ -150,18 +150,30 @@ def call(
             subgraph_path: Optional way to define the subgraph via a Cypher MATCH clause.
 
         Returns:
-            A `DeclarativeBase` instance for constructing queries.
+            A ``DeclarativeBase`` instance for constructing queries.
 
         Examples:
-            Python: `call('export_util.json', '/home/user', "LABEL", ["TYPE1", "TYPE2"]).execute()`
-            Cypher: `MATCH p=(a)-[:TYPE1 | :TYPE2]->(b) WHERE (a:LABEL) AND (b:LABEL)
-                     WITH project(p) AS graph CALL export_util.json(graph, '/home/user')`
+            Python:
+                ```python
+                call('export_util.json', '/home/user', "LABEL", ["TYPE1", "TYPE2"]).execute()
+                ```
+            Cypher:
+                ```cypher
+                MATCH p=(a)-[:TYPE1 | :TYPE2]->(b) WHERE (a:LABEL) AND (b:LABEL)
+                WITH project(p) AS graph CALL export_util.json(graph, '/home/user')
+                ```
 
             or
 
-            Python: `call('export_util.json', '/home/user', subgraph_path="(:LABEL)-[:TYPE]->(:LABEL)").execute()`
-            Cypher: `MATCH p=(:LABEL)-[:TYPE1]->(:LABEL) WITH project(p) AS graph
-                    CALL export_util.json(graph, '/home/user')`
+            Python:
+                ```python
+                call('export_util.json', '/home/user', subgraph_path="(:LABEL)-[:TYPE]->(:LABEL)").execute()
+                ```
+            Cypher:
+                ```cypher
+                MATCH p=(:LABEL)-[:TYPE1]->(:LABEL) WITH project(p) AS graph
+                CALL export_util.json(graph, '/home/user')
+                ```
         """
 
         if not (node_labels is None and relationship_types is None):

gqlalchemy/transformations/importing/graph_importer.py

@@ -86,7 +86,11 @@ def translate(self, graph) -> None:
             memgraph.execute(query)
 
     def translate_dot_file(self, path: str) -> None:
-        """Parses a DOT file to a NetworkX graph and imports it to Memgraph."""
+        """Parses a DOT file to a NetworkX graph and imports it to Memgraph. This method is available when ``graph_type="NX"``
+
+        Args:
+            - ``path`` - Path to a DOT file.
+        """
         self._raise_if_not_nx_importer()
         raise_if_not_imported(dependency=pydot, dependency_name="pydot")
 
@@ -98,7 +102,11 @@ def translate_dot_file(self, path: str) -> None:
         self.translate(graph)
 
     def translate_dot_data(self, dot_data: str) -> None:
-        """Parses DOT content to a NetworkX graph and imports it to Memgraph."""
+        """Parses DOT content to a NetworkX graph and imports it to Memgraph.
+
+        Args:
+            - ``dot_data`` - Raw DOT graph content.
+        """
         self._raise_if_not_nx_importer()
         raise_if_not_imported(dependency=pydot, dependency_name="pydot")
 

gqlalchemy/vendors/memgraph.py

@@ -631,7 +631,7 @@ def delete_graph_statistics(self, labels: Optional[List[str]] = None) -> List[di
         after significant changes to the graph structure or data.
 
         Args:
-            labels: Optional list of labels to delete statistics for.
+            labels ``_Optional[List[str]]_``:  Optional list of labels to delete statistics for.
                 If None, deletes statistics for all labels.
 
         Returns: