Skip to content

Commit 346c807

Browse files
committed
Dcoumentation style accoding to flake8
1 parent 51add7c commit 346c807

File tree

2 files changed

+13
-11
lines changed

2 files changed

+13
-11
lines changed

xarray_sentinel/conventions.py

+3-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
1-
"""CF representation of metadata according to
2-
Sentinel-1 Product Specification: S1-RS-MDA-52-7441, DI-MPC-PB, MPC-0240, 3/7, 27/02/2020 See:
1+
"""CF representation of metadata according to Sentinel-1 Product Specification.
2+
3+
See: S1-RS-MDA-52-7441, DI-MPC-PB, MPC-0240, 3/7, 27/02/2020
34
https://sentinel.esa.int/documents/247904/1877131/Sentinel-1-Product-Specification
45
"""
56

xarray_sentinel/sentinel1.py

+10-9
Original file line numberDiff line numberDiff line change
@@ -582,9 +582,10 @@ def crop_burst_dataset(
582582
use_center: bool = False,
583583
burst_id: T.Optional[int] = None,
584584
) -> DataArrayOrDataset:
585-
"""
586-
Returns the measurement dataset cropped to the selected burst.
585+
"""Return the measurement dataset cropped to the selected burst.
586+
587587
Only one keyword between 'burst_index' and 'azimuth_anx_time' and 'burst_id' must be defined.
588+
588589
:param xr.Dataset pol_dataset: measurement dataset
589590
:param int burst_index: burst index can take values from 1 to the number of bursts
590591
:param float azimuth_anx_time: azimuth anx time of first line of the bursts
@@ -659,9 +660,11 @@ def mosaic_slc_iw(
659660
def calibrate_amplitude(
660661
digital_number: xr.DataArray, calibration_lut: xr.DataArray
661662
) -> xr.DataArray:
662-
"""Returns the calibrated amplitude. The calibration is done using the calibration LUT in the product metadata.
663+
"""Return the calibrated amplitude. The calibration is done using the calibration LUT in the product metadata.
664+
663665
:param digital_number: digital numbers to be calibrated
664666
:param calibration_lut: calibration LUT (sigmaNought, betaNought or gamma).
667+
665668
The LUT can be opened using the measurement sub-group `calibration`
666669
"""
667670
calibration = calibration_lut.interp(
@@ -685,8 +688,8 @@ def calibrate_intensity(
685688
as_db: bool = False,
686689
min_db: T.Optional[float] = -40.0,
687690
) -> xr.DataArray:
688-
"""
689-
Returns the calibrated intensity. The calibration is done using the calibration LUT in the product metadata.
691+
"""Return the calibrated intensity. The calibration is done using the calibration LUT in the product metadata.
692+
690693
:param digital_number: digital numbers to be calibrated
691694
:param calibration_lut: calibration LUT (sigmaNought, betaNought or gamma).
692695
The LUT can be opened using the measurement sub-group `calibration`.
@@ -717,14 +720,12 @@ def slant_range_time_to_ground_range(
717720
slant_range_time: xr.DataArray,
718721
coordinate_conversion: xr.Dataset,
719722
) -> xr.DataArray:
720-
"""
721-
Convert the slant range time coordinates to ground range coordinates using the coordinate conversion `sr0`
722-
and `srgrCoefficients` product metadata
723+
"""Convert slant range time to ground range using the coordinate conversion metadata.
724+
723725
:param azimuth_time: azimuth time coordinates
724726
:param slant_range_time: slant range time
725727
:param coordinate_conversion: coordinate conversion dataset.
726728
The coordinate conversion dataset can be opened using the measurement sub-groub `coordinate_conversion`
727-
:return:
728729
"""
729730
slant_range = SPEED_OF_LIGHT / 2.0 * slant_range_time
730731
cc = coordinate_conversion.interp(azimuth_time=azimuth_time)

0 commit comments

Comments
 (0)