Skip to content

Commit fe847d7

Browse files
jbaross-pometrygithub-actions[bot]miratepuffin
authored
James/python docstrings (#2273)
* is_active * is_active * version * misc missing docstrings * operator docstrings * format * additional docstrings * missing parameters * operations docstrings * docstring syntax fixes * declare missing modules * declare missing modules * declare missing modules * declare missing modules * declare missing modules * declare missing modules * declare missing modules * declare missing modules * docstring syntax fixes * rename PyMetadataListList to MetadataListList * rename PyMetadataListList to MetadataListList * docstring syntax fixes * docstring syntax fixes * docstring syntax fixes * docstring syntax fixes * docstring syntax fixes * docstring syntax fixes * update stubsgen CI step * chore: apply tidy-public auto-fixes * chore: apply tidy-public auto-fixes * review fixes * review fixes * chore: apply tidy-public auto-fixes * review fixes * from value to casted value * chore: apply tidy-public auto-fixes * review fixes * chore: apply tidy-public auto-fixes --------- Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> Co-authored-by: Ben Steer <[email protected]>
1 parent db0c971 commit fe847d7

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

64 files changed

+4313
-925
lines changed

‎docs/reference/graphql/graphql_API.md‎

Lines changed: 45 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -938,6 +938,9 @@ Returns the end time of the window. Returns none if no window is applied.
938938

939939
Returns the source node of the edge.
940940

941+
Returns:
942+
Node:
943+
941944
</td>
942945
</tr>
943946
<tr>
@@ -947,6 +950,9 @@ Returns the source node of the edge.
947950

948951
Returns the destination node of the edge.
949952

953+
Returns:
954+
Node:
955+
950956
</td>
951957
</tr>
952958
<tr>
@@ -956,6 +962,9 @@ Returns the destination node of the edge.
956962

957963
Returns the node at the other end of the edge (same as dst() for out-edges and src() for in-edges).
958964

965+
Returns:
966+
Node:
967+
959968
</td>
960969
</tr>
961970
<tr>
@@ -965,6 +974,9 @@ Returns the node at the other end of the edge (same as dst() for out-edges and s
965974

966975
Returns the id of the edge.
967976

977+
Returns:
978+
list[str]:
979+
968980
</td>
969981
</tr>
970982
<tr>
@@ -1030,6 +1042,9 @@ Each new edge object contains only updates from the respective layers.
10301042

10311043
Returns a list of timestamps of when an edge is added or change to an edge is made.
10321044

1045+
Returns:
1046+
List[int]:
1047+
10331048
</td>
10341049
</tr>
10351050
<tr>
@@ -1039,6 +1054,9 @@ Returns a list of timestamps of when an edge is added or change to an edge is ma
10391054

10401055
Returns a list of timestamps of when an edge is deleted.
10411056

1057+
Returns:
1058+
List[int]:
1059+
10421060
</td>
10431061
</tr>
10441062
<tr>
@@ -1515,6 +1533,9 @@ Returns the end time of the window or none if there is no window.
15151533

15161534
Returns the number of edges.
15171535

1536+
Returns:
1537+
int:
1538+
15181539
</td>
15191540
</tr>
15201541
<tr>
@@ -2018,6 +2039,9 @@ Returns the earliest time that any edge in this graph is valid.
20182039

20192040
Returns the number of edges in the graph.
20202041

2042+
Returns:
2043+
int:
2044+
20212045
</td>
20222046
</tr>
20232047
<tr>
@@ -2329,43 +2353,43 @@ This allows you to specify multiple operations together.
23292353
</thead>
23302354
<tbody>
23312355
<tr>
2332-
<td colspan="2" valign="top"><strong id="graphalgorithmplugin.pagerank">pagerank</strong></td>
2333-
<td valign="top">[<a href="#pagerankoutput">PagerankOutput</a>!]!</td>
2356+
<td colspan="2" valign="top"><strong id="graphalgorithmplugin.shortest_path">shortest_path</strong></td>
2357+
<td valign="top">[<a href="#shortestpathoutput">ShortestPathOutput</a>!]!</td>
23342358
<td></td>
23352359
</tr>
23362360
<tr>
2337-
<td colspan="2" align="right" valign="top">iterCount</td>
2338-
<td valign="top"><a href="#int">Int</a>!</td>
2361+
<td colspan="2" align="right" valign="top">source</td>
2362+
<td valign="top"><a href="#string">String</a>!</td>
23392363
<td></td>
23402364
</tr>
23412365
<tr>
2342-
<td colspan="2" align="right" valign="top">threads</td>
2343-
<td valign="top"><a href="#int">Int</a></td>
2366+
<td colspan="2" align="right" valign="top">targets</td>
2367+
<td valign="top">[<a href="#string">String</a>!]!</td>
23442368
<td></td>
23452369
</tr>
23462370
<tr>
2347-
<td colspan="2" align="right" valign="top">tol</td>
2348-
<td valign="top"><a href="#float">Float</a></td>
2371+
<td colspan="2" align="right" valign="top">direction</td>
2372+
<td valign="top"><a href="#string">String</a></td>
23492373
<td></td>
23502374
</tr>
23512375
<tr>
2352-
<td colspan="2" valign="top"><strong id="graphalgorithmplugin.shortest_path">shortest_path</strong></td>
2353-
<td valign="top">[<a href="#shortestpathoutput">ShortestPathOutput</a>!]!</td>
2376+
<td colspan="2" valign="top"><strong id="graphalgorithmplugin.pagerank">pagerank</strong></td>
2377+
<td valign="top">[<a href="#pagerankoutput">PagerankOutput</a>!]!</td>
23542378
<td></td>
23552379
</tr>
23562380
<tr>
2357-
<td colspan="2" align="right" valign="top">source</td>
2358-
<td valign="top"><a href="#string">String</a>!</td>
2381+
<td colspan="2" align="right" valign="top">iterCount</td>
2382+
<td valign="top"><a href="#int">Int</a>!</td>
23592383
<td></td>
23602384
</tr>
23612385
<tr>
2362-
<td colspan="2" align="right" valign="top">targets</td>
2363-
<td valign="top">[<a href="#string">String</a>!]!</td>
2386+
<td colspan="2" align="right" valign="top">threads</td>
2387+
<td valign="top"><a href="#int">Int</a></td>
23642388
<td></td>
23652389
</tr>
23662390
<tr>
2367-
<td colspan="2" align="right" valign="top">direction</td>
2368-
<td valign="top"><a href="#string">String</a></td>
2391+
<td colspan="2" align="right" valign="top">tol</td>
2392+
<td valign="top"><a href="#float">Float</a></td>
23692393
<td></td>
23702394
</tr>
23712395
</tbody>
@@ -2610,6 +2634,9 @@ Returns the number of nodes in the graph.
26102634

26112635
Returns the number of edges in the graph.
26122636

2637+
Returns:
2638+
int:
2639+
26132640
</td>
26142641
</tr>
26152642
<tr>
@@ -6888,6 +6915,8 @@ Some properties and metadata.
68886915

68896916
### SomePropertySpec
68906917

6918+
SomePropertySpec object containing lists of metadata and property names.
6919+
68916920
<table>
68926921
<thead>
68936922
<tr>

‎python/python/raphtory/__init__.py‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@
88
_sys.modules["raphtory.vectors"] = vectors
99
_sys.modules["raphtory.graphql"] = graphql
1010
_sys.modules["raphtory.filter"] = filter
11+
_sys.modules["raphtory.iterables"] = iterables
1112

1213
__doc__ = _raphtory.__doc__
1314
if hasattr(_raphtory, "__all__"):

0 commit comments

Comments
 (0)