Skip to content

Commit

Permalink
remove "whether to" from docs (#498)
Browse files Browse the repository at this point in the history
Co-authored-by: Matic Lubej <[email protected]>
  • Loading branch information
mlubej and Matic Lubej authored Nov 13, 2023
1 parent 4d19a60 commit 593459c
Show file tree
Hide file tree
Showing 3 changed files with 6 additions and 6 deletions.
4 changes: 2 additions & 2 deletions sentinelhub/base.py
Original file line number Diff line number Diff line change
Expand Up @@ -214,8 +214,8 @@ def _filter_repeating_items(download_list: list[DownloadRequest]) -> tuple[list[
def _preprocess_request(self, save_data: bool, return_data: bool) -> None:
"""Prepares requests for download and creates empty folders
:param save_data: Tells whether to save data or not
:param return_data: Tells whether to return data or not
:param save_data: Save data
:param return_data: Return data
"""
if not self.is_valid_request():
raise ValueError("Cannot obtain data because request is invalid")
Expand Down
4 changes: 2 additions & 2 deletions sentinelhub/geo_utils.py
Original file line number Diff line number Diff line change
Expand Up @@ -130,7 +130,7 @@ def utm_to_pixel(
:param east: east coordinate of point
:param north: north coordinate of point
:param transform: georeferencing transform of the image, e.g. `(x_upper_left, res_x, 0, y_upper_left, 0, -res_y)`
:param truncate: Whether to truncate pixel coordinates. Default is `True`
:param truncate: Truncate pixel coordinates. Default is `True`
:return: row and column pixel image coordinates
"""
column = (east - transform[0]) / transform[1]
Expand Down Expand Up @@ -164,7 +164,7 @@ def wgs84_to_pixel(
:param lat: latitude of point
:param transform: georeferencing transform of the image, e.g. `(x_upper_left, res_x, 0, y_upper_left, 0, -res_y)`
:param utm_epsg: UTM coordinate reference system enum constants
:param truncate: Whether to truncate pixel coordinates. Default is `True`
:param truncate: Truncate pixel coordinates. Default is `True`
:return: row and column pixel image coordinates
"""
east, north = wgs84_to_utm(lng, lat, utm_epsg)
Expand Down
4 changes: 2 additions & 2 deletions sentinelhub/io_utils.py
Original file line number Diff line number Diff line change
Expand Up @@ -109,8 +109,8 @@ def write_data( # noqa: C901
:param filename: name of file to write data to
:param data: image data to write to file
:param data_format: format of output file. Default is `None`
:param compress: whether to compress data or not. Default is `False`
:param add: whether to append to existing file or not. Only supported for TXT. Default is `False`
:param compress: Compress data. Default is `False`
:param add: Append to existing file. Only supported for TXT. Default is `False`
:raises: exception if numpy format is not supported or file cannot be written
"""
_create_parent_folder(filename)
Expand Down

0 comments on commit 593459c

Please sign in to comment.