Merge pull request #619 from adamnsch/deprecations-doc-bug

Align graph catalog deprecations correctly in ref docs

Author: brs96

doc/sphinx/source/graph.rst

@@ -33,52 +33,55 @@ These all assume that an object of :class:`.GraphDataScience` is available as `g
 .. deprecated:: 2.5.0
    Since GDS server version 2.5.0 you should use the endpoint :func:`gds.graph.nodeLabel.write` instead.
 
-.. deprecated:: 2.5.0
-   Since GDS server version 2.5.0 you should use the endpoint :func:`gds.graph.export.csv` instead.
-
 .. py:function:: gds.beta.graph.export.csv(G: Graph, **config: Any) -> Series[Any]
 
     Exports a named graph to CSV files.
 
 .. deprecated:: 2.5.0
-   Since GDS server version 2.5.0 you should use the endpoint :func:`gds.graph.export.csv.estimate` instead.
+   Since GDS server version 2.5.0 you should use the endpoint :func:`gds.graph.export.csv` instead.
 
-.. py:function:: gds.beta.graph.export.csv.estimate(G: Graph, **config: Any) -> "Series[Any]
+.. py:function:: gds.beta.graph.export.csv.estimate(G: Graph, **config: Any) -> Series[Any]
 
     Estimate the required disk space for exporting a named graph to CSV files.
 
+.. deprecated:: 2.5.0
+   Since GDS server version 2.5.0 you should use the endpoint :func:`gds.graph.export.csv.estimate` instead.
+
 .. py:function:: gds.beta.graph.generate(graph_name: str, node_count: int, average_degree: int, **config: Any) -> GraphCreateResult
 
     Computes a random graph, which will be stored in the graph catalog.
 
 .. deprecated:: 2.5.0
-   Since GDS server version 2.5.0 you should use the endpoint :func:`gds.graph.filter` instead.
+   Since GDS server version 2.5.0 you should use the endpoint :func:`gds.graph.generate` instead.
 
-.. py:function:: gds.beta.graph.project.subgraph(graph_name: str,from_G: Graph,node_filter: str,relationship_filter: str,**config: Any,) -> GraphCreateResult
+.. py:function:: gds.beta.graph.project.subgraph(graph_name: str, from_G: Graph, node_filter: str, relationship_filter: str, **config: Any,) -> GraphCreateResult
 
-    Creates a named graph in the catalog for use by algorithms.
+    Filters down a graph projection to a named subgraph projection in the catalog for use by algorithms.
 
 .. deprecated:: 2.5.0
-   Since GDS server version 2.5.0 you should use the endpoint :func:`gds.graph.relationships.stream` instead.
+   Since GDS server version 2.5.0 you should use the endpoint :func:`gds.graph.filter` instead.
 
 .. py:function:: gds.beta.graph.relationships.stream(G: Graph, relationship_types: List[str] = ["*"], **config: Any) -> TopologyDataFrame
 
     Streams the given relationship source/target pairs
 
 .. deprecated:: 2.5.0
-   Since GDS server version 2.5.0 you should use the endpoint :func:`gds.graph.relationships.toUndirected` instead.
+   Since GDS server version 2.5.0 you should use the endpoint :func:`gds.graph.relationships.stream` instead.
 
 .. py:function:: gds.beta.graph.relationships.toUndirected(G: Graph, query: str, relationship_type: str, mutate_relationship_type: str, **config: Any) -> Series[Any]
 
     The ToUndirected procedure converts directed relationships to undirected relationships
 
 .. deprecated:: 2.5.0
-   Since GDS server version 2.5.0 you should use the endpoint :func:`gds.graph.relationships.toUndirected.estimate` instead.
+   Since GDS server version 2.5.0 you should use the endpoint :func:`gds.graph.relationships.toUndirected` instead.
 
 .. py:function:: gds.beta.graph.relationships.toUndirected.estimate(G: Graph, relationship_type: str, mutate_relationship_type: str, **config: Any) -> Series[Any]
 
     Returns an estimation of the memory consumption for that procedure.
 
+.. deprecated:: 2.5.0
+   Since GDS server version 2.5.0 you should use the endpoint :func:`gds.graph.relationships.toUndirected.estimate` instead.
+
 .. py:function:: gds.graph.cypher.project(query: str, database: Optional[str], **params: Any) -> GraphCreateResult
 
     Use Cypher projection to creates a named graph in the catalog for use by algorithms.
@@ -104,7 +107,7 @@ These all assume that an object of :class:`.GraphDataScience` is available as `g
 
     Exports a named graph to CSV files.
 
-.. py:function:: gds.graph.export.csv.estimate(G: Graph, **config: Any) -> "Series[Any]
+.. py:function:: gds.graph.export.csv.estimate(G: Graph, **config: Any) -> Series[Any]
 
     Estimate the required disk space for exporting a named graph to CSV files.
 
@@ -156,9 +159,12 @@ These all assume that an object of :class:`.GraphDataScience` is available as `g
 
     Returns an estimation of the memory consumption for that procedure.
 
-.. py:function:: gds.graph.project.subgraph(graph_name: str,from_G: Graph,node_filter: str,relationship_filter: str,**config: Any,) -> GraphCreateResult
+.. py:function:: gds.graph.project.subgraph(graph_name: str, from_G: Graph, node_filter: str, relationship_filter: str, **config: Any,) -> GraphCreateResult
 
-    Creates a named graph in the catalog for use by algorithms.
+    Filters down a graph projection to a named subgraph projection in the catalog for use by algorithms.
+
+.. deprecated:: 2.5.0
+   Since GDS server version 2.5.0 you should use the endpoint :func:`gds.graph.filter` instead.
 
 .. py:function:: gds.graph.relationships.stream(G: Graph, relationship_types: List[str] = ["*"], **config: Any) -> TopologyDataFrame
 
@@ -257,3 +263,7 @@ These all assume that an object of :class:`.GraphDataScience` is available as `g
 
 .. py:function:: gds.graph.nodeLabel.write(G: Graph, node_label: str, **config: Any) -> Series[Any]
     Writes the given node Label to an online Neo4j database.
+
+.. py:function:: gds.graph.filter(graph_name: str, from_G: Graph, node_filter: str, relationship_filter: str, **config: Any,) -> GraphCreateResult
+
+    Filters down a graph projection to a named subgraph projection in the catalog for use by algorithms.