From 593459c3ece05d8f8cc851df07c770bd75812238 Mon Sep 17 00:00:00 2001 From: Matic Lubej Date: Mon, 13 Nov 2023 15:22:07 +0100 Subject: [PATCH] remove "whether to" from docs (#498) Co-authored-by: Matic Lubej --- sentinelhub/base.py | 4 ++-- sentinelhub/geo_utils.py | 4 ++-- sentinelhub/io_utils.py | 4 ++-- 3 files changed, 6 insertions(+), 6 deletions(-) diff --git a/sentinelhub/base.py b/sentinelhub/base.py index e41dc52f..e02732c6 100644 --- a/sentinelhub/base.py +++ b/sentinelhub/base.py @@ -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") diff --git a/sentinelhub/geo_utils.py b/sentinelhub/geo_utils.py index 6c2cdaf0..75078b1d 100644 --- a/sentinelhub/geo_utils.py +++ b/sentinelhub/geo_utils.py @@ -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] @@ -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) diff --git a/sentinelhub/io_utils.py b/sentinelhub/io_utils.py index 88d7f6ed..c48562c1 100644 --- a/sentinelhub/io_utils.py +++ b/sentinelhub/io_utils.py @@ -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)