Update emissions documentation [ci skip]

ibi-group · Nov 8, 2023 · ebcb1d6 · ebcb1d6
1 parent de8bace
commit ebcb1d6
Show file tree

Hide file tree

Showing 4 changed files with 6 additions and 2 deletions.
diff --git a/docs/BuildConfiguration.md b/docs/BuildConfiguration.md
@@ -55,7 +55,7 @@ Sections follow that describe particular settings in more depth.
 | demDefaults                                                              |   `object`  | Default properties for DEM extracts.                                                                                                                           | *Optional* |                                   |  2.3  |
 |    [elevationUnitMultiplier](#demDefaults_elevationUnitMultiplier)       |   `double`  | Specify a multiplier to convert elevation units from source to meters.                                                                                         | *Optional* | `1.0`                             |  2.3  |
 | [elevationBucket](#elevationBucket)                                      |   `object`  | Used to download NED elevation tiles from the given AWS S3 bucket.                                                                                             | *Optional* |                                   |   na  |
-| [emissions](sandbox/Emissions.md)                                        |   `object`  | Emissions configuration.                                                                                                                                       | *Optional* |                                   |   na  |
+| [emissions](sandbox/Emissions.md)                                        |   `object`  | Emissions configuration.                                                                                                                                       | *Optional* |                                   |  2.5  |
 | [fares](sandbox/Fares.md)                                                |   `object`  | Fare configuration.                                                                                                                                            | *Optional* |                                   |  2.0  |
 | gtfsDefaults                                                             |   `object`  | The gtfsDefaults section allows you to specify default properties for GTFS files.                                                                              | *Optional* |                                   |  2.3  |
 |    blockBasedInterlining                                                 |  `boolean`  | Whether to create stay-seated transfers in between two trips with the same block id.                                                                           | *Optional* | `true`                            |  2.3  |

diff --git a/docs/sandbox/Emissions.md b/docs/sandbox/Emissions.md
@@ -63,7 +63,7 @@ the `carAvgOccupancy` provides the average number of passengers in a car.
 
 | Config Parameter |    Type   | Summary                                                    |  Req./Opt. | Default Value | Since |
 |------------------|:---------:|------------------------------------------------------------|:----------:|---------------|:-----:|
-| carAvgCo2PerKm   | `integer` | The average CO₂ emissions of a car in grams per kilometer. | *Optional* | `170`         |   na  |
+| carAvgCo2PerKm   | `integer` | The average CO₂ emissions of a car in grams per kilometer. | *Optional* | `170`         |  2.5  |
 | carAvgOccupancy  |  `double` | The average number of passengers in a car.                 | *Optional* | `1.3`         |   na  |
 
 

diff --git a/mkdocs.yml b/mkdocs.yml
@@ -110,3 +110,4 @@ nav:
     - IBI Accessibility Score: 'sandbox/IBIAccessibilityScore.md'
     - Fares: 'sandbox/Fares.md'
     - Ride Hailing: 'sandbox/RideHailing.md'
+    - Emissions: 'sandbox/Emissions.md'
diff --git a/src/ext/java/org/opentripplanner/ext/emissions/EmissionsConfig.java b/src/ext/java/org/opentripplanner/ext/emissions/EmissionsConfig.java
@@ -1,6 +1,7 @@
 package org.opentripplanner.ext.emissions;
 
 import org.opentripplanner.standalone.config.framework.json.NodeAdapter;
+import org.opentripplanner.standalone.config.framework.json.OtpVersion;
 
 /**
  * This class is responsible for mapping emissions configuration into emissions parameters.
@@ -13,6 +14,7 @@ public class EmissionsConfig {
   public EmissionsConfig(String parameterName, NodeAdapter root) {
     var c = root
       .of(parameterName)
+      .since(OtpVersion.V2_5)
       .summary("Emissions configuration.")
       .description(
         """
@@ -26,6 +28,7 @@ public EmissionsConfig(String parameterName, NodeAdapter root) {
     this.carAvgCo2PerKm =
       c
         .of("carAvgCo2PerKm")
+        .since(OtpVersion.V2_5)
         .summary("The average CO₂ emissions of a car in grams per kilometer.")
         .asInt(170);