fix: update docstring

This commit is contained in:
Ceri Loosley 2025-06-11 18:59:48 +01:00
commit 073d8017f5
No known key found for this signature in database

View file

@ -402,6 +402,7 @@ def clean_time(time_entry: str | timedelta | int | float | None, translator: Tra
- `"PT1H30M"` - returns "1 hour 30 minutes" - `"PT1H30M"` - returns "1 hour 30 minutes"
- `timedelta(hours=1, minutes=30)` - returns "1 hour 30 minutes" - `timedelta(hours=1, minutes=30)` - returns "1 hour 30 minutes"
- `{"minValue": "PT1H30M"}` - returns "1 hour 30 minutes" - `{"minValue": "PT1H30M"}` - returns "1 hour 30 minutes"
- `30` - as a `int` or `float` assumed to be in minutes, returns "30 minutes"
Raises: Raises:
TypeError: if the type is not supported a TypeError is raised TypeError: if the type is not supported a TypeError is raised