Skip to content

Commit 2b18491

Browse files
committed
Testing autodoc typehinting
1 parent a8b5396 commit 2b18491

File tree

3 files changed

+6
-6
lines changed

3 files changed

+6
-6
lines changed

docs/source/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Welcome to pyfracval's documentation!
22

3-
![PyFracVAL Logo](_static/logo.png)
3+
<img src="_static/logo.png" alt="PyFracVAL Logo" width="50%">
44

55
PyFracVAL generates fractal-like aggregates... (add a brief description)
66

pyfracval/cca_agg.py

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -84,7 +84,7 @@ def __init__(
8484
)
8585
# This could indicate an issue from PCA subclustering stage.
8686

87-
self.N = n_total
87+
self.N: int = n_total
8888
self.df = df
8989
self.kf = kf
9090
self.tol_ov = tol_ov
@@ -1058,8 +1058,9 @@ def run_cca(self) -> Tuple[np.ndarray, np.ndarray] | None:
10581058
-------
10591059
tuple[np.ndarray, np.ndarray] | None
10601060
A tuple containing:
1061-
- final_coords (np.ndarray): Nx3 coordinates of the final aggregate.
1062-
- final_radii (np.ndarray): N radii of the final aggregate.
1061+
- final_coords (np.ndarray): Nx3 coordinates of the final aggregate.
1062+
- final_radii (np.ndarray): N radii of the final aggregate.
1063+
10631064
Returns None if the aggregation process fails at any stage
10641065
(sets `self.not_able_cca` to True).
10651066
"""

pyfracval/utils.py

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,12 +19,11 @@ def shuffle_array(arr: np.ndarray) -> np.ndarray:
1919
2020
Parameters
2121
----------
22-
arr : np.ndarray
22+
arr :
2323
The 1D NumPy array to shuffle.
2424
2525
Returns
2626
-------
27-
np.ndarray
2827
The input `arr`, modified in-place.
2928
"""
3029
n = len(arr)

0 commit comments

Comments
 (0)