closes #353

r-package/NEWS.md

@@ -3,6 +3,8 @@
 **Minor changes**
 
 - In the `accessibility()` function, the value of `max_trip_duration` is now capped by the max value passed to the `cutoffs` parameter. Closes [#342](https://github.com/ipeaGIT/r5r/issues/348).
+- Updated documentation of parameter `max_walk_time` to make it clear that in walk-only trips, whenever `max_walk_time` differs from `max_trip_duration`, the lowest value is considered. Closes [#353](https://github.com/ipeaGIT/r5r/issues/353)
+- Updated documentation of parameter `max_bike_time` to make it clear that in bicycle-only trips, whenever `max_bike_time` differs from `max_trip_duration`, the lowest value is considered. Closes [#353](https://github.com/ipeaGIT/r5r/issues/353)
 
 
 # r5r 1.1.0

r-package/man/roxygen/templates/common_arguments.R

@@ -12,19 +12,25 @@
 #'   for valid dates. Please see details for further information on how
 #'   datetimes are parsed.
 #' @param max_walk_time An integer. The maximum walking time (in minutes) to
-#'   access and egress the transit network, or to make transfers within the
-#'   network. Defaults to no restrictions, as long as `max_trip_duration` is
-#'   respected. The max time is considered separately for each leg (e.g. if
-#'   you set `max_walk_time` to 15, you could potentially walk up to 15 minutes
-#'   to reach transit, and up to _another_ 15 minutes to reach the destination
-#'   after leaving transit). Defaults to `Inf`, no limit.
+#'   access and egress the transit network, to make transfers within the network
+#'   or to complete walk-only trips. Defaults to no restrictions (numeric value
+#'   of `Inf`), as long as `max_trip_duration` is respected. When routing
+#'   transit trips, the max time is considered separately for each leg (e.g. if
+#'   you set `max_walk_time` to 15, you could get trips with an up to 15 minutes
+#'   walk leg to reach transit and another up to 15 minutes walk leg to reach
+#'   the destination after leaving transit. In walk-only trips, whenever
+#'   `max_walk_time` differs from `max_trip_duration`, the lowest value is
+#'   considered.
 #' @param max_bike_time An integer. The maximum cycling time (in minutes) to
-#'   access and egress the transit network. Defaults to no restrictions, as long
-#'   as `max_trip_duration` is respected. The max time is considered separately
-#'   for each leg (e.g. if you set `max_bike_time` to 15 minutes, you could
-#'   potentially cycle up to 15 minutes to reach transit, and up to _another_ 15
-#'   minutes to reach the destination after leaving transit). Defaults to `Inf`,
-#'   no limit.
+#'   access and egress the transit network, to make transfers within the network
+#'   or to complete bicycle-only trips. Defaults to no restrictions (numeric
+#'   value of `Inf`), as long as `max_trip_duration` is respected. When routing
+#'   transit trips, the max time is considered separately for each leg (e.g. if
+#'   you set `max_bike_time` to 15, you could get trips with an up to 15 minutes
+#'   cycle leg to reach transit and another up to 15 minutes cycle leg to reach
+#'   the destination after leaving transit. In bicycle-only trips, whenever
+#'   `max_bike_time` differs from `max_trip_duration`, the lowest value is
+#'   considered.
 #' @param max_car_time An integer. The maximum driving time (in minutes) to
 #'   access and egress the transit network. Defaults to no restrictions, as long
 #'   as `max_trip_duration` is respected. The max time is considered separately