Skip to content
This repository was archived by the owner on Sep 11, 2023. It is now read-only.

Commit d5ba87b

Browse files
committed
add function description
1 parent 2975ad5 commit d5ba87b

File tree

1 file changed

+11
-1
lines changed

1 file changed

+11
-1
lines changed

nowcasting_dataset/data_sources/fake/coordinates.py

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,17 @@ def make_random_image_coords_osgb(
2525
y_center_osgb: Optional = None,
2626
km_spaceing: Optional[int] = 4,
2727
):
28-
"""Make random coords for image. These are ranges for the pixels"""
28+
"""
29+
Make random coords for image. These are ranges for the pixels
30+
31+
Args:
32+
size: The size of the coordinates to make
33+
x_center_osgb: center coord for x (in osgb)
34+
y_center_osgb: center coord for y (in osgb)
35+
km_spaceing: the km spacing between the coordinates.
36+
37+
Returns: X,Y random coordinates [OSGB]
38+
"""
2939

3040
ONE_KILOMETER = 10**3
3141

0 commit comments

Comments
 (0)