Skip to content

Commit c077aaa

Browse files
committed
fix, docs: remove default precision from docstring
The default precision gets rendered via the Sphinx API output, and they were out-of-sync.
1 parent 2da69d8 commit c077aaa

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

src/stactools/core/utils/raster_footprint.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ def update_geometry_from_asset_footprint(
5353
extract footprints. The first successful footprint will be used. If the
5454
list is empty, all assets will be tried until one is successful.
5555
precision (int): The number of decimal places to include in the coordinates for the
56-
reprojected geometry. Defaults to 3 decimal places.
56+
reprojected geometry.
5757
densification_factor (Optional[int]): The factor by which to increase point density within
5858
the polygon.
5959
A factor of 2 would double the density of points (placing one new point between each
@@ -111,7 +111,7 @@ def data_footprints_for_data_assets(
111111
extract footprints. The first successful footprint will be used. If the
112112
list is empty, all assets will be tried until one is successful.
113113
precision (int): The number of decimal places to include in the coordinates for
114-
the reprojected geometry. Defaults to 3 decimal places.
114+
the reprojected geometry.
115115
densification_factor (Optional[int]): The factor by which to increase point density
116116
within the polygon. A factor of 2 would double the density of points (placing one
117117
new point between each existing pair of points), a factor of 3 would place two points
@@ -189,7 +189,7 @@ def data_footprint(
189189
Args:
190190
href (str): The href of the image to process.
191191
precision (int): The number of decimal places to include in the coordinates for the
192-
reprojected geometry. Defaults to 3 decimal places.
192+
reprojected geometry.
193193
densification_factor (Optional[int]): The factor by which to increase point density
194194
within the polygon. A factor of 2 would double the density of points (placing one
195195
new point between each existing pair of points), a factor of 3 would place two points
@@ -268,7 +268,7 @@ def densify_reproject_simplify(
268268
new point between each existing pair of points), a factor of 3 would place two points
269269
between each point, etc.
270270
precision (int): The number of decimal places to include in the coordinates for the
271-
reprojected geometry. Defaults to 3 decimal places.
271+
reprojected geometry.
272272
simplify_tolerance (Optional[float]): All points in the simplified object will be within
273273
the tolerance distance of the original geometry, in degrees.
274274

0 commit comments

Comments
 (0)