Skip to content

Commit c0d407f

Browse files
committed
Clarify when rate-related properties are allowed
1 parent f3b9017 commit c0d407f

1 file changed

Lines changed: 9 additions & 3 deletions

File tree

policy/README.md

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -255,7 +255,7 @@ An individual `Rule` object is defined by the following fields:
255255
| `propulsion_types` | `propulsion_type[]` | Optional | Applicable vehicle [propulsion types][propulsion-types], default "all". |
256256
| `minimum` | integer | Optional | Minimum value, if applicable (default 0) |
257257
| `maximum` | integer | Optional | Maximum value, if applicable (default unlimited) |
258-
| `rate_amount` | integer | Optional | The amount of a rate applied when this rule applies, if applicable (default zero). A positive integer rate amount represents a fee, while a negative integer represents a subsidy. Rate amounts are given in the `currency` defined in the [Policy](#policy). |
258+
| `rate_amount` | integer | Optional | Amount of the rate (see [Rate Amounts](#rate-amounts)) |
259259
| `rate_recurrence` | enum | Optional | Recurrence of the rate (see [Rate Recurrences](#rate-recurrences)) |
260260
| `start_time` | ISO 8601 time `hh:mm:ss` | Optional | Beginning time-of-day when the rule is in effect (default 00:00:00). |
261261
| `end_time` | ISO 8601 time `hh:mm:ss` | Optional | Ending time-of-day when the rule is in effect (default 23:59:59). |
@@ -308,9 +308,15 @@ An individual `Rule` object is defined by the following fields:
308308

309309
[Top][toc]
310310

311-
### Rate Recurrences
311+
### Rates
312+
Rate-related properties can currently be specified on `rate` and `time` Rules. Note: A future MDS version will likely support rates for `count` and `speed` rules, but their behavior is currently undefined.
312313

313-
Rate recurrences specify when a rate is applied – either once, or periodically according to a `time_unit` specified using [Rule Units](#rule-units). A `time_unit` refers to a unit of time as measured in local time for the juristiction – a day begins at midnight local time, an hour begins at the top of the hour, etc.
314+
#### Rate Amounts
315+
The amount of a rate applied when this rule applies, if applicable (default zero). A positive integer rate amount represents a fee, while a negative integer represents a subsidy. Rate amounts are given in the `currency` defined in the [Policy](#policy).
316+
317+
#### Rate Recurrences
318+
319+
Rate recurrences specify when a rate is applied – either once, or periodically according to a `time_unit` specified using [Rule Units](#rule-units). A `time_unit` refers to a unit of time as measured in local time for the jurisdiction – a day begins at midnight local time, an hour begins at the top of the hour, etc.
314320

315321
| Name | Description |
316322
| --------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- |

0 commit comments

Comments
 (0)