Skip to content

Commit

Permalink
docs(dataset): fix documentation errors
Browse files Browse the repository at this point in the history
  • Loading branch information
wvenialbo committed Oct 25, 2024
1 parent 5f053d9 commit 769ad6b
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 8 deletions.
2 changes: 1 addition & 1 deletion src/GOES_DL/dataset/base/locator_gg.py
Original file line number Diff line number Diff line change
Expand Up @@ -98,7 +98,7 @@ def get_datetime(self, filename: str) -> datetime:
Returns
-------
datetime:
datetime
The `datetime` extracted from the filename.
Raises
Expand Down
14 changes: 7 additions & 7 deletions src/GOES_DL/dataset/gridsat/locator.py
Original file line number Diff line number Diff line change
Expand Up @@ -91,21 +91,21 @@ class GridSatProductLocator(ProductLocatorGG):
Methods
-------
get_date_format() -> str:
get_date_format()
Return the date format specification for the GridSat product's
filename.
get_paths(datetime_ini: datetime, datetime_fin: datetime) -> list[str]:
get_paths(datetime_ini: datetime, datetime_fin: datetime)
Generate a list of paths containing the product files for the
specified date range.
get_prefix() -> str:
get_prefix()
Generate the prefix for the GridSat product's filename.
get_suffix() -> str:
get_suffix()
Generate the suffix for the GridSat product's filename.
get_timestamp_pattern() -> str:
get_timestamp_pattern()
Return the timestamp pattern for the GridSat product's filename.
next_time(current_time: datetime) -> datetime:
next_time(current_time: datetime)
Get the next time interval.
normalize_times(datetime_ini: datetime, datetime_fin: datetime) -> tuple[datetime, datetime]:
normalize_times(datetime_ini: datetime, datetime_fin: datetime)
Normalise the initial and final datetimes.
Caution
Expand Down

0 comments on commit 769ad6b

Please sign in to comment.