remove manualy written type info from python docs

remi-dupre · Feb 3, 2025 · b40f97c · b40f97c
1 parent b25cc0b
commit b40f97c
Show file tree

Hide file tree

Showing 2 changed files with 44 additions and 86 deletions.
diff --git a/opening-hours-py/src/lib.rs b/opening-hours-py/src/lib.rs
@@ -65,28 +65,20 @@ fn validate(oh: &str) -> bool {
 ///
 /// Parameters
 /// ----------
-/// oh : str
-///     Opening hours expression as defined in OSM (eg. "24/7").
-///     See https://wiki.openstreetmap.org/wiki/Key:opening_hours/specification
-/// timezone : Optional[zoneinfo.ZoneInfo]
-///     Timezone where the physical place attached to these opening hours lives
-///     in. When specified, operations on this expression will return dates
-///     attached to this timezone and input times in other timezones will be
-///     converted.
-/// country : Optional[str]
-///     ISO code of the country this physical place lives in. This will be used
-///     to load a calendar of local public holidays.
-/// coords : Optional[tuple[float, float]]
-///     (latitude, longitude) of this place. When this is specified together
-///     with a timezone sun events will be accurate (sunrise, sunset, dusk,
-///     dawn). By default, this will be used to automatically detect the
-///     timezone and a country code.
-/// auto_country : bool (default: `True`)
-///     If set to `True`, the country code will automatically be inferred from
-///     coordinates when they are specified.
-/// auto_timezone : bool (default: `True`)
-///     If set to `True`, the timezone will automatically be inferred from
-///     coordinates when they are specified.
+/// - oh: Opening hours expression as defined in OSM (eg. "24/7"). See
+///   https://wiki.openstreetmap.org/wiki/Key:opening_hours/specification
+/// - timezone: Timezone where the physical place attached to these opening hours lives in. When
+///   specified, operations on this expression will return dates attached to this timezone and
+///   input times in other timezones will be converted.
+/// - country: ISO code of the country this physical place lives in. This will be used to load a
+///   calendar of local public holidays.
+/// - coords: (latitude, longitude) of this place. When this is specified together with a timezone
+///   sun events will be accurate (sunrise, sunset, dusk, dawn). By default, this will be used to
+///   automatically detect the timezone and a country code.
+/// - auto_country: If set to `True`, the country code will automatically be inferred from
+///   coordinates when they are specified.
+/// - auto_timezone: If set to `True`, the timezone will automatically be inferred from coordinates
+///   when they are specified.
 ///
 /// Raises
 /// ------
@@ -170,9 +162,7 @@ impl PyOpeningHours {
     ///
     /// Parameters
     /// ----------
-    /// time : Optional[datetime]
-    ///     Base time for the evaluation, current time will be used if it is
-    ///     not specified.
+    /// - time: Base time for the evaluation, current time will be used if it is not specified.
     ///
     /// Examples
     /// --------
@@ -188,9 +178,7 @@ impl PyOpeningHours {
     ///
     /// Parameters
     /// ----------
-    /// time : Optional[datetime]
-    ///     Base time for the evaluation, current time will be used if it is
-    ///     not specified.
+    /// - time: Base time for the evaluation, current time will be used if it is not specified.
     ///
     /// Examples
     /// --------
@@ -206,9 +194,7 @@ impl PyOpeningHours {
     ///
     /// Parameters
     /// ----------
-    /// time : Optional[datetime]
-    ///     Base time for the evaluation, current time will be used if it is
-    ///     not specified.
+    /// - time: Base time for the evaluation, current time will be used if it is not specified.
     ///
     /// Examples
     /// --------
@@ -224,9 +210,7 @@ impl PyOpeningHours {
     ///
     /// Parameters
     /// ----------
-    /// time : Optional[datetime]
-    ///     Base time for the evaluation, current time will be used if it is
-    ///     not specified.
+    /// - time: Base time for the evaluation, current time will be used if it is not specified.
     ///
     /// Examples
     /// --------
@@ -243,9 +227,7 @@ impl PyOpeningHours {
     ///
     /// Parameters
     /// ----------
-    /// time : Optional[datetime]
-    ///     Base time for the evaluation, current time will be used if it is
-    ///     not specified.
+    /// - time: Base time for the evaluation, current time will be used if it is not specified.
     ///
     /// Examples
     /// --------
@@ -266,12 +248,9 @@ impl PyOpeningHours {
     ///
     /// Parameters
     /// ----------
-    /// start: Optional[datetime]
-    ///     Initial time for the iterator, current time will be used if it is
-    ///     not specified.
-    /// end : Optional[datetime]
-    ///     Maximal time for the iterator, the iterator will continue until
-    ///     year 9999 if it no max is specified.
+    /// - start: Initial time for the iterator, current time will be used if it is not specified.
+    /// - end: Maximal time for the iterator, the iterator will continue until year 9999 if it no
+    ///   max is specified.
     ///
     /// Examples
     /// --------

diff --git a/opening_hours.pyi b/opening_hours.pyi
@@ -13,28 +13,20 @@ class OpeningHours:
 
     Parameters
     ----------
-    oh : str
-        Opening hours expression as defined in OSM (eg. "24/7").
-        See https://wiki.openstreetmap.org/wiki/Key:opening_hours/specification
-    timezone : Optional[zoneinfo.ZoneInfo]
-        Timezone where the physical place attached to these opening hours lives
-        in. When specified, operations on this expression will return dates
-        attached to this timezone and input times in other timezones will be
-        converted.
-    country : Optional[str]
-        ISO code of the country this physical place lives in. This will be used
-        to load a calendar of local public holidays.
-    coords : Optional[tuple[float, float]]
-        (latitude, longitude) of this place. When this is specified together
-        with a timezone sun events will be accurate (sunrise, sunset, dusk,
-        dawn). By default, this will be used to automatically detect the
-        timezone and a country code.
-    auto_country : bool (default: `True`)
-        If set to `True`, the country code will automatically be inferred from
-        coordinates when they are specified.
-    auto_timezone : bool (default: `True`)
-        If set to `True`, the timezone will automatically be inferred from
-        coordinates when they are specified.
+    - oh: Opening hours expression as defined in OSM (eg. "24/7"). See
+      https://wiki.openstreetmap.org/wiki/Key:opening_hours/specification
+    - timezone: Timezone where the physical place attached to these opening hours lives in. When
+      specified, operations on this expression will return dates attached to this timezone and
+      input times in other timezones will be converted.
+    - country: ISO code of the country this physical place lives in. This will be used to load a
+      calendar of local public holidays.
+    - coords: (latitude, longitude) of this place. When this is specified together with a timezone
+      sun events will be accurate (sunrise, sunset, dusk, dawn). By default, this will be used to
+      automatically detect the timezone and a country code.
+    - auto_country: If set to `True`, the country code will automatically be inferred from
+      coordinates when they are specified.
+    - auto_timezone: If set to `True`, the timezone will automatically be inferred from coordinates
+      when they are specified.
 
     Raises
     ------
@@ -68,9 +60,7 @@ class OpeningHours:
 
         Parameters
         ----------
-        time : Optional[datetime]
-            Base time for the evaluation, current time will be used if it is
-            not specified.
+        - time: Base time for the evaluation, current time will be used if it is not specified.
 
         Examples
         --------
@@ -85,9 +75,7 @@ class OpeningHours:
 
         Parameters
         ----------
-        time : Optional[datetime]
-            Base time for the evaluation, current time will be used if it is
-            not specified.
+        - time: Base time for the evaluation, current time will be used if it is not specified.
 
         Examples
         --------
@@ -104,9 +92,7 @@ class OpeningHours:
 
         Parameters
         ----------
-        time : Optional[datetime]
-            Base time for the evaluation, current time will be used if it is
-            not specified.
+        - time: Base time for the evaluation, current time will be used if it is not specified.
 
         Examples
         --------
@@ -123,9 +109,7 @@ class OpeningHours:
 
         Parameters
         ----------
-        time : Optional[datetime]
-            Base time for the evaluation, current time will be used if it is
-            not specified.
+        - time: Base time for the evaluation, current time will be used if it is not specified.
 
         Examples
         --------
@@ -143,9 +127,7 @@ class OpeningHours:
 
         Parameters
         ----------
-        time : Optional[datetime]
-            Base time for the evaluation, current time will be used if it is
-            not specified.
+        - time: Base time for the evaluation, current time will be used if it is not specified.
 
         Examples
         --------
@@ -168,12 +150,9 @@ class OpeningHours:
 
         Parameters
         ----------
-        start: Optional[datetime]
-            Initial time for the iterator, current time will be used if it is
-            not specified.
-        end : Optional[datetime]
-            Maximal time for the iterator, the iterator will continue until
-            year 9999 if it no max is specified.
+        - start: Initial time for the iterator, current time will be used if it is not specified.
+        - end: Maximal time for the iterator, the iterator will continue until year 9999 if it no
+          max is specified.
 
         Examples
         --------