Skip to content

Commit baf3640

Browse files
committed
Fix docstrings to not use new types
1 parent e76fb09 commit baf3640

20 files changed

+126
-126
lines changed

graphdatascience/procedure_surface/api/catalog/node_label_endpoints.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -82,11 +82,11 @@ def write(
8282
Whether to log progress
8383
username : str | None, default=None
8484
The username to attribute the procedure run to
85-
concurrency : Any | None, default=None
85+
concurrency : int | None
8686
The number of concurrent threads
87-
write_concurrency : Any | None, default=None
87+
write_concurrency : int | None
8888
The number of concurrent threads used for the mutation
89-
job_id : Any | None, default=None
89+
job_id : str | None
9090
An identifier for the job
9191
Returns
9292
-------

graphdatascience/procedure_surface/api/catalog/node_properties_endpoints.py

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -40,15 +40,15 @@ def stream(
4040
Whether to include node labels in the stream
4141
node_labels : list[str]
4242
Filter by node labels
43-
concurrency : Any | None, default=None
43+
concurrency : int | None
4444
The number of concurrent threads
4545
sudo : bool
4646
Override memory estimation limits
4747
log_progress : bool | None, default=None
4848
Whether to log progress
4949
username : str | None, default=None
5050
The username to attribute the procedure run to
51-
job_id : Any | None, default=None
51+
job_id : str | None
5252
An identifier for the job
5353
db_node_properties : list[str] | None, default=None
5454
Retrieves additional node properties from the database and attaches them to the stream.
@@ -85,17 +85,17 @@ def write(
8585
If a dictionary is provided, the keys are the property names and the values are the aliases that will be used as the property name in the database.
8686
node_labels : list[str]
8787
Filter by node labels
88-
concurrency : Any | None, default=None
88+
concurrency : int | None
8989
The number of concurrent threads
90-
write_concurrency : Any | None, default=None
90+
write_concurrency : int | None
9191
The number of concurrent threads used for writing
9292
sudo : bool
9393
Override memory estimation limits
9494
log_progress : bool | None, default=None
9595
Whether to log progress
9696
username : str | None, default=None
9797
The username to attribute the procedure run to
98-
job_id : Any | None, default=None
98+
job_id : str | None
9999
An identifier for the job
100100
Returns
101101
-------

graphdatascience/procedure_surface/api/catalog/scale_properties_endpoints.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -53,9 +53,9 @@ def mutate(
5353
Display progress logging.
5454
username : str | None, default=None
5555
The username to attribute the procedure run to
56-
concurrency : Any | None, default=None
56+
concurrency : int | None
5757
Number of threads to use for running the algorithm.
58-
job_id : Any | None, default=None
58+
job_id : str | None
5959
Identifier for the job.
6060
6161
Returns

graphdatascience/procedure_surface/api/centrality/articlerank_endpoints.py

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -68,9 +68,9 @@ def mutate(
6868
Display progress logging.
6969
username : str | None, default=None
7070
The username to attribute the procedure run to
71-
concurrency : Any | None, default=None
71+
concurrency : int | None
7272
Number of threads to use for running the algorithm.
73-
job_id : Any | None, default=None
73+
job_id : str | None
7474
Identifier for the job.
7575
relationship_weight_property : str | None, default=None
7676
Name of the property to be used as weights.
@@ -135,9 +135,9 @@ def stats(
135135
Display progress logging.
136136
username : str | None, default=None
137137
The username to attribute the procedure run to
138-
concurrency : Any | None, default=None
138+
concurrency : int | None
139139
Number of threads to use for running the algorithm.
140-
job_id : Any | None, default=None
140+
job_id : str | None
141141
Identifier for the job.
142142
relationship_weight_property : str | None, default=None
143143
Name of the property to be used as weights.
@@ -194,9 +194,9 @@ def stream(
194194
Whether to log progress
195195
username : str | None, default=None
196196
The username to attribute the procedure run to
197-
concurrency : Any | None, default=None
197+
concurrency : int | None
198198
The number of concurrent threads
199-
job_id : Any | None, default=None
199+
job_id : str | None
200200
An identifier for the job
201201
relationship_weight_property : str | None, default=None
202202
The property name that contains weight
@@ -265,9 +265,9 @@ def write(
265265
Display progress logging.
266266
username : str | None, default=None
267267
The username to attribute the procedure run to
268-
concurrency : Any | None, default=None
268+
concurrency : int | None
269269
Number of threads to use for running the algorithm.
270-
job_id : Any | None, default=None
270+
job_id : str | None
271271
Identifier for the job.
272272
relationship_weight_property : str | None, default=None
273273
Name of the property to be used as weights.
@@ -316,7 +316,7 @@ def estimate(
316316
The relationships types used to select relationships for this algorithm run
317317
node_labels : list[str]
318318
The node labels used to select nodes for this algorithm run
319-
concurrency : Any | None, default=None
319+
concurrency : int | None
320320
The number of concurrent threads
321321
relationship_weight_property : str | None, default=None
322322
The property name that contains weight

graphdatascience/procedure_surface/api/centrality/articulationpoints_endpoints.py

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -46,9 +46,9 @@ def mutate(
4646
Whether to log progress
4747
username : str | None, default=None
4848
The username to attribute the procedure run to
49-
concurrency : Any | None, default=None
49+
concurrency : int | None
5050
The number of concurrent threads
51-
job_id : Any | None, default=None
51+
job_id : str | None
5252
An identifier for the job
5353
5454
Returns
@@ -88,9 +88,9 @@ def stats(
8888
Whether to log progress
8989
username : str | None, default=None
9090
The username to attribute the procedure run to
91-
concurrency : Any | None, default=None
91+
concurrency : int | None
9292
The number of concurrent threads
93-
job_id : Any | None, default=None
93+
job_id : str | None
9494
An identifier for the job
9595
9696
Returns
@@ -128,9 +128,9 @@ def stream(
128128
Whether to log progress
129129
username : str | None, default=None
130130
The username to attribute the procedure run to
131-
concurrency : Any | None, default=None
131+
concurrency : int | None
132132
The number of concurrent threads
133-
job_id : Any | None, default=None
133+
job_id : str | None
134134
An identifier for the job
135135
136136
Returns
@@ -176,11 +176,11 @@ def write(
176176
Whether to log progress
177177
username : str | None, default=None
178178
The username to attribute the procedure run to
179-
concurrency : Any | None, default=None
179+
concurrency : int | None
180180
The number of concurrent threads
181-
job_id : Any | None, default=None
181+
job_id : str | None
182182
An identifier for the job
183-
write_concurrency : Any | None, default=None
183+
write_concurrency : int | None
184184
The number of concurrent threads for writing
185185
186186
Returns
@@ -208,7 +208,7 @@ def estimate(
208208
The relationship types used to select relationships for this algorithm run.
209209
node_labels : list[str]
210210
The node labels used to select nodes for this algorithm run.
211-
concurrency : Any | None, default=None
211+
concurrency : int | None
212212
The number of concurrent threads used for the estimation.
213213
214214
Returns

graphdatascience/procedure_surface/api/centrality/betweenness_endpoints.py

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -56,9 +56,9 @@ def mutate(
5656
Display progress logging.
5757
username : str | None, default=None
5858
The username to attribute the procedure run to
59-
concurrency : Any | None, default=None
59+
concurrency : int | None
6060
Number of threads to use for running the algorithm.
61-
job_id : Any | None, default=None
61+
job_id : str | None
6262
Identifier for the job.
6363
relationship_weight_property : str | None, default=None
6464
Name of the property to be used as weights.
@@ -110,9 +110,9 @@ def stats(
110110
Display progress logging.
111111
username : str | None, default=None
112112
The username to attribute the procedure run to
113-
concurrency : Any | None, default=None
113+
concurrency : int | None
114114
Number of threads to use for running the algorithm.
115-
job_id : Any | None, default=None
115+
job_id : str | None
116116
Identifier for the job.
117117
relationship_weight_property : str | None, default=None
118118
Name of the property to be used as weights.
@@ -159,9 +159,9 @@ def stream(
159159
Whether to log progress
160160
username : str | None, default=None
161161
The username to attribute the procedure run to
162-
concurrency : Any | None, default=None
162+
concurrency : int | None
163163
The number of concurrent threads
164-
job_id : Any | None, default=None
164+
job_id : str | None
165165
An identifier for the job
166166
relationship_weight_property : str | None, default=None
167167
The property name that contains relationship weights
@@ -217,13 +217,13 @@ def write(
217217
Display progress logging.
218218
username : str | None, default=None
219219
The username to attribute the procedure run to
220-
concurrency : Any | None, default=None
220+
concurrency : int | None
221221
Number of threads to use for running the algorithm.
222-
job_id : Any | None, default=None
222+
job_id : str | None
223223
Identifier for the job.
224224
relationship_weight_property : str | None, default=None
225225
Name of the property to be used as weights.
226-
write_concurrency : Any | None, default=None
226+
write_concurrency : int | None
227227
The number of concurrent threads during the write phase
228228
229229
Returns
@@ -258,7 +258,7 @@ def estimate(
258258
The relationship types used to select relationships for this algorithm run
259259
node_labels : list[str]
260260
The node labels used to select nodes for this algorithm run
261-
concurrency : Any | None, default=None
261+
concurrency : int | None
262262
The number of concurrent threads
263263
relationship_weight_property : str | None, default=None
264264
The property name that contains weight

graphdatascience/procedure_surface/api/centrality/celf_endpoints.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -101,7 +101,7 @@ def stats(
101101
Probability of a node being activated by an active neighbour node.
102102
monte_carlo_simulations : int | None, default=None
103103
Number of Monte-Carlo simulations.
104-
random_seed : Any | None, default=None
104+
random_seed : int | None
105105
Random seed for reproducible results.
106106
relationship_types : list[str]
107107
Filter the graph using the given relationship types. Relationships with any of the given types will be included.
@@ -113,9 +113,9 @@ def stats(
113113
Display progress logging.
114114
username : str | None, default=None
115115
The username to attribute the procedure run to
116-
concurrency : Any | None, default=None
116+
concurrency : int | None
117117
Number of threads to use for running the algorithm.
118-
job_id : Any | None, default=None
118+
job_id : str | None
119119
Identifier for the job.
120120
121121
Returns

graphdatascience/procedure_surface/api/centrality/closeness_endpoints.py

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -52,9 +52,9 @@ def mutate(
5252
Whether to log progress of the algorithm execution
5353
username : str | None, default=None
5454
The username to attribute the procedure run to
55-
concurrency : Any | None, default=None
55+
concurrency : int | None
5656
The number of concurrent threads used for the algorithm execution.
57-
job_id : Any | None, default=None
57+
job_id : str | None
5858
An identifier for the job that can be used for monitoring and cancellation
5959
6060
Returns
@@ -101,9 +101,9 @@ def stats(
101101
Whether to log progress of the algorithm execution
102102
username : str | None, default=None
103103
The username to attribute the procedure run to
104-
concurrency : Any | None, default=None
104+
concurrency : int | None
105105
The number of concurrent threads used for the algorithm execution.
106-
job_id : Any | None, default=None
106+
job_id : str | None
107107
An identifier for the job that can be used for monitoring and cancellation
108108
109109
Returns
@@ -200,11 +200,11 @@ def write(
200200
Whether to log progress of the algorithm execution
201201
username : str | None, default=None
202202
The username to attribute the procedure run to
203-
concurrency : Any | None, default=None
203+
concurrency : int | None
204204
The number of concurrent threads used for the algorithm execution.
205-
job_id : Any | None, default=None
205+
job_id : str | None
206206
An identifier for the job that can be used for monitoring and cancellation
207-
write_concurrency : Any | None, default=None
207+
write_concurrency : int | None
208208
The number of concurrent threads used during the write phase.
209209
210210
Returns
@@ -236,7 +236,7 @@ def estimate(
236236
The relationship types used to select relationships for this algorithm run.
237237
node_labels : list[str]
238238
The node labels used to select nodes for this algorithm run.
239-
concurrency : Any | None, default=None
239+
concurrency : int | None
240240
The number of concurrent threads used for the algorithm execution.
241241
242242
Returns

graphdatascience/procedure_surface/api/centrality/closeness_harmonic_endpoints.py

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -48,9 +48,9 @@ def mutate(
4848
Whether to log progress of the algorithm execution
4949
username : str | None, default=None
5050
The username to attribute the procedure run to
51-
concurrency : Any | None, default=None
51+
concurrency : int | None
5252
The number of concurrent threads used for the algorithm execution.
53-
job_id : Any | None, default=None
53+
job_id : str | None
5454
An identifier for the job that can be used for monitoring and cancellation
5555
5656
Returns
@@ -95,9 +95,9 @@ def stats(
9595
Whether to log progress of the algorithm execution
9696
username : str | None, default=None
9797
The username to attribute the procedure run to
98-
concurrency : Any | None, default=None
98+
concurrency : int | None
9999
The number of concurrent threads used for the algorithm execution.
100-
job_id : Any | None, default=None
100+
job_id : str | None
101101
An identifier for the job that can be used for monitoring and cancellation
102102
103103
Returns
@@ -137,9 +137,9 @@ def stream(
137137
Whether to log progress of the algorithm execution
138138
username : str | None, default=None
139139
The username to attribute the procedure run to
140-
concurrency : Any | None, default=None
140+
concurrency : int | None
141141
The number of concurrent threads used for the algorithm execution.
142-
job_id : Any | None, default=None
142+
job_id : str | None
143143
An identifier for the job that can be used for monitoring and cancellation
144144
145145
Returns
@@ -188,11 +188,11 @@ def write(
188188
Whether to log progress of the algorithm execution
189189
username : str | None, default=None
190190
The username to attribute the procedure run to
191-
concurrency : Any | None, default=None
191+
concurrency : int | None
192192
The number of concurrent threads used for the algorithm execution.
193-
job_id : Any | None, default=None
193+
job_id : str | None
194194
An identifier for the job that can be used for monitoring and cancellation
195-
write_concurrency : Any | None, default=None
195+
write_concurrency : int | None
196196
The number of concurrent threads during the write phase
197197
198198
Returns
@@ -221,7 +221,7 @@ def estimate(
221221
The relationship types used to select relationships for this algorithm run.
222222
node_labels : list[str]
223223
The node labels used to select nodes for this algorithm run.
224-
concurrency : Any | None, default=None
224+
concurrency : int | None
225225
The number of concurrent threads used for the algorithm execution.
226226
227227
Returns

0 commit comments

Comments
 (0)