Skip to content

Commit ca3c549

Browse files
committed
Align graph catalog deprecations correctly in ref docs
1 parent 33b25b4 commit ca3c549

File tree

1 file changed

+14
-11
lines changed

1 file changed

+14
-11
lines changed

doc/sphinx/source/graph.rst

Lines changed: 14 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -33,52 +33,55 @@ These all assume that an object of :class:`.GraphDataScience` is available as `g
3333
.. deprecated:: 2.5.0
3434
Since GDS server version 2.5.0 you should use the endpoint :func:`gds.graph.nodeLabel.write` instead.
3535

36-
.. deprecated:: 2.5.0
37-
Since GDS server version 2.5.0 you should use the endpoint :func:`gds.graph.export.csv` instead.
38-
3936
.. py:function:: gds.beta.graph.export.csv(G: Graph, **config: Any) -> Series[Any]
4037
4138
Exports a named graph to CSV files.
4239

4340
.. deprecated:: 2.5.0
44-
Since GDS server version 2.5.0 you should use the endpoint :func:`gds.graph.export.csv.estimate` instead.
41+
Since GDS server version 2.5.0 you should use the endpoint :func:`gds.graph.export.csv` instead.
4542

46-
.. py:function:: gds.beta.graph.export.csv.estimate(G: Graph, **config: Any) -> "Series[Any]
43+
.. py:function:: gds.beta.graph.export.csv.estimate(G: Graph, **config: Any) -> Series[Any]
4744
4845
Estimate the required disk space for exporting a named graph to CSV files.
4946

47+
.. deprecated:: 2.5.0
48+
Since GDS server version 2.5.0 you should use the endpoint :func:`gds.graph.export.csv.estimate` instead.
49+
5050
.. py:function:: gds.beta.graph.generate(graph_name: str, node_count: int, average_degree: int, **config: Any) -> GraphCreateResult
5151
5252
Computes a random graph, which will be stored in the graph catalog.
5353

5454
.. deprecated:: 2.5.0
55-
Since GDS server version 2.5.0 you should use the endpoint :func:`gds.graph.filter` instead.
55+
Since GDS server version 2.5.0 you should use the endpoint :func:`gds.graph.generate` instead.
5656

57-
.. py:function:: gds.beta.graph.project.subgraph(graph_name: str,from_G: Graph,node_filter: str,relationship_filter: str,**config: Any,) -> GraphCreateResult
57+
.. py:function:: gds.beta.graph.project.subgraph(graph_name: str,from_G: Graph, node_filter: str,relationship_filter: str,**config: Any,) -> GraphCreateResult
5858
5959
Creates a named graph in the catalog for use by algorithms.
6060

6161
.. deprecated:: 2.5.0
62-
Since GDS server version 2.5.0 you should use the endpoint :func:`gds.graph.relationships.stream` instead.
62+
Since GDS server version 2.5.0 you should use the endpoint :func:`gds.graph.filter` instead.
6363

6464
.. py:function:: gds.beta.graph.relationships.stream(G: Graph, relationship_types: List[str] = ["*"], **config: Any) -> TopologyDataFrame
6565
6666
Streams the given relationship source/target pairs
6767

6868
.. deprecated:: 2.5.0
69-
Since GDS server version 2.5.0 you should use the endpoint :func:`gds.graph.relationships.toUndirected` instead.
69+
Since GDS server version 2.5.0 you should use the endpoint :func:`gds.graph.relationships.stream` instead.
7070

7171
.. py:function:: gds.beta.graph.relationships.toUndirected(G: Graph, query: str, relationship_type: str, mutate_relationship_type: str, **config: Any) -> Series[Any]
7272
7373
The ToUndirected procedure converts directed relationships to undirected relationships
7474

7575
.. deprecated:: 2.5.0
76-
Since GDS server version 2.5.0 you should use the endpoint :func:`gds.graph.relationships.toUndirected.estimate` instead.
76+
Since GDS server version 2.5.0 you should use the endpoint :func:`gds.graph.relationships.toUndirected` instead.
7777

7878
.. py:function:: gds.beta.graph.relationships.toUndirected.estimate(G: Graph, relationship_type: str, mutate_relationship_type: str, **config: Any) -> Series[Any]
7979
8080
Returns an estimation of the memory consumption for that procedure.
8181

82+
.. deprecated:: 2.5.0
83+
Since GDS server version 2.5.0 you should use the endpoint :func:`gds.graph.relationships.toUndirected.estimate` instead.
84+
8285
.. py:function:: gds.graph.cypher.project(query: str, database: Optional[str], **params: Any) -> GraphCreateResult
8386
8487
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
104107
105108
Exports a named graph to CSV files.
106109

107-
.. py:function:: gds.graph.export.csv.estimate(G: Graph, **config: Any) -> "Series[Any]
110+
.. py:function:: gds.graph.export.csv.estimate(G: Graph, **config: Any) -> Series[Any]
108111
109112
Estimate the required disk space for exporting a named graph to CSV files.
110113

0 commit comments

Comments
 (0)