Skip to content

Commit

Permalink
feat: add doctstring;add param;add type defence
Browse files Browse the repository at this point in the history
  • Loading branch information
CBROWN-ONS committed Feb 9, 2024
1 parent d95f698 commit b0930c8
Showing 1 changed file with 6 additions and 1 deletion.
7 changes: 6 additions & 1 deletion src/transport_performance/gtfs/validation.py
Original file line number Diff line number Diff line change
Expand Up @@ -1447,6 +1447,7 @@ def html_report(
overwrite: bool = False,
summary_type: str = "mean",
extended_validation: bool = True,
clean_feed: bool = True,
) -> None:
"""Generate a HTML report describing the GTFS data.
Expand All @@ -1462,7 +1463,9 @@ def html_report(
default "mean"
extended_validation : bool, optional
Whether or not to create extended reports for gtfs validation
errors/warnings.
errors/warnings, by default True
clean_feed : bool, optional
Whether or not to clean the feed before validating, by default True
Returns
-------
Expand All @@ -1475,6 +1478,8 @@ def html_report(
"""
_type_defence(overwrite, "overwrite", bool)
_type_defence(clean_feed, "clean_feed", bool)
_type_defence(extended_validation, "extended_validation", bool)
_type_defence(summary_type, "summary_type", str)
_set_up_report_dir(path=report_dir, overwrite=overwrite)
summary_type = summary_type.lower().strip()
Expand Down

0 comments on commit b0930c8

Please sign in to comment.