Apply suggestions from code review - only annotations

nick-knowles · Mar 11, 2024 · 21df396 · 21df396
1 parent e894d32
commit 21df396
Show file tree

Hide file tree

Showing 10 changed files with 23 additions and 23 deletions.
diff --git a/examples/functions/deckPlans/DeckPlans-Example.xml b/examples/functions/deckPlans/DeckPlans-Example.xml
@@ -225,7 +225,7 @@
 						</LuggageBayEquipment>
 						<TicketingEquipment version="any" id="onboard_ticket_machine">
 							<TicketMachines>true</TicketMachines>
-							<PaymentMethods>cashAndCard contactlessPaymentCard  travelCard</PaymentMethods>
+							<PaymentMethods>cashAndCard contactlessPaymentCard travelCard</PaymentMethods>
 						</TicketingEquipment>
 						<HelpPointEquipment version="any" id="stop_button">
 							<HeightFromGround>1.00</HeightFromGround>
@@ -872,7 +872,7 @@
 												<DeckVehicleEntrance version="any" id="dd@deck_2@stairs">
 													<Width>0.80</Width>
 													<Height>2.00</Height>
-													<Name>ENtrance to top of  stairs</Name>
+													<Name>Entrance to top of stairs</Name>
 													<DeckEntranceType>internal</DeckEntranceType>
 												</DeckVehicleEntrance>
 											</deckEntrances>
@@ -1621,7 +1621,7 @@
 					</deckPlans>
 					<schematicMaps>
 						<SchematicMap version="any" id="dd">
-							<Name>Basic Elements for  map of bus</Name>
+							<Name>Basic Elements for map of a bus</Name>
 							<ImageUri>http:erebus.eu/plans/double_decker_floor_plan</ImageUri>
 							<members>
 								<SchematicMapMember version="any" id="dd@deck_1@">
@@ -1637,7 +1637,7 @@
 									<PassengerEntranceRef version="any" ref="dd@deck_1@rear"/>
 								</SchematicMapMember>
 								<SchematicMapMember version="any" id="dd@deck_1@stairs">
-									<Name>Stairs </Name>
+									<Name>Stairs</Name>
 									<PassengerEntranceRef version="any" ref="dd@deck_1@stairs"/>
 								</SchematicMapMember>
 								<SchematicMapMember version="any" id="dd@deck_2@">
@@ -1649,11 +1649,11 @@
 					</schematicMaps>
 				</ResourceFrame>
 				<ServiceFrame version="1.0" id="mb:deck_plan_example" responsibilitySetRef="mb:vehicle_data">
-					<Name>Deck Plan  Assignment   Example</Name>
-					<Description>This is an example showing how one might assign a Deck Entrance to a journey so as to state which entrance will be at which point on teh platform .  More sense for a train of ferry .</Description>
+					<Name>Deck Plan Assignment Example</Name>
+					<Description>This is an example showing how one might assign a Deck Entrance to a journey to state which entrance will be at which boarding position on the platform. Most relevant for a train or a ferry.</Description>
 					<stopAssignments>
 						<PassengerStopAssignment version="any" id="sj001a" order="1">
-							<Name>To a particalr stopt</Name>
+							<Name>To a particular stop.</Name>
 							<ScheduledStopPointRef versionRef="EXTERNAL" ref="Gotham_bus_station"/>
 							<StopPlaceRef versionRef="EXTERNAL" ref="Gotham_bus"/>
 							<QuayRef versionRef="EXTERNAL" ref="Gotham_bus@P1"/>
@@ -1676,7 +1676,7 @@
 									<AlightingUse>true</AlightingUse>
 									<PositionOfTrainElement>1</PositionOfTrainElement>
 									<BoardingPositionRef versionRef="EXTERNAL" ref="Gotham_bus@P1@B"/>
-									<EntranceToVehicle>exit  at rear</EntranceToVehicle>
+									<EntranceToVehicle>Exit at rear</EntranceToVehicle>
 									<deckEntranceAssignments>
 										<DeckEntranceAssignment version="any" id="sj001a@rear">
 											<PassengerEntranceRef version="any" ref="dd@deck_1@rear"/>

diff --git a/xsd/netex_framework/netex_responsibility/netex_responsibilitySet_version.xsd b/xsd/netex_framework/netex_responsibility/netex_responsibilitySet_version.xsd
@@ -437,7 +437,7 @@ Rail transport, Roads and Road transport
 			</xsd:element>
 			<xsd:element name="ContractGoverningLaw" type="MultilingualString" minOccurs="0">
 				<xsd:annotation>
-					<xsd:documentation>Legal jurisdictin  coverbimg the contract</xsd:documentation>
+					<xsd:documentation>Legal jurisdiction covering the contract.</xsd:documentation>
 				</xsd:annotation>
 			</xsd:element>
 			<xsd:element name="contractees" minOccurs="0">
@@ -452,7 +452,7 @@ Rail transport, Roads and Road transport
 			</xsd:element>
 			<xsd:element name="contractors" type="organisationRefs_RelStructure">
 				<xsd:annotation>
-					<xsd:documentation>The contractor is that party that provides agreed services or goods to the Contractee according to the conditions in a Contract.</xsd:documentation>
+					<xsd:documentation>The contractor is that party that provides agreed services or goods to the contractee according to the conditions in a contract.</xsd:documentation>
 				</xsd:annotation>
 			</xsd:element>
 			<xsd:element name="contractDocuments" minOccurs="0">

diff --git a/xsd/netex_framework/netex_reusableComponents/netex_deckPlan_version.xsd b/xsd/netex_framework/netex_reusableComponents/netex_deckPlan_version.xsd
@@ -449,8 +449,8 @@
 	</xsd:complexType>
 	<xsd:element name="PassengerSpace" substitutionGroup="DeckSpace_">
 		<xsd:annotation>
-			<xsd:documentation> A specialisation of DECK SPACE defining an area within a VEHICLE (i.e. bus, boat, coach, car) or TRAIN ELEMENT for use by passengers. _2.0
-+v2.0</xsd:documentation>
+			<xsd:documentation> A specialisation of DECK SPACE defining an area within a VEHICLE (i.e. bus, boat, coach, car) or TRAIN ELEMENT for use by passengers. +v2.0
+</xsd:documentation>
 		</xsd:annotation>
 		<xsd:complexType>
 			<xsd:complexContent>
@@ -719,7 +719,7 @@
 			</xsd:element>
 			<xsd:element name="SequenceFromFront" type="xsd:positiveInteger" minOccurs="0">
 				<xsd:annotation>
-					<xsd:documentation>Positional sequence of door from front (orr left side end)  of VEHICLE. 1 - forward, </xsd:documentation>
+					<xsd:documentation>Positional sequence of door from front to end (or left side to right)  of VEHICLE. Start with 1.</xsd:documentation>
 				</xsd:annotation>
 			</xsd:element>
 			<xsd:element name="HeightFromGround" type="LengthType" minOccurs="0">
@@ -731,7 +731,7 @@
 	</xsd:group>
 	<xsd:group name="DeckEntranceClassificationGroup">
 		<xsd:annotation>
-			<xsd:documentation>EClassification lements for a DECK ENTRANCE.</xsd:documentation>
+			<xsd:documentation>Classification elements for a DECK ENTRANCE.</xsd:documentation>
 		</xsd:annotation>
 		<xsd:sequence>
 			<xsd:element name="DeckEntranceType" type="DeckEntranceTypeEnumeration" minOccurs="0">
@@ -1199,7 +1199,7 @@
 			</xsd:element>
 			<xsd:element name="HeightFromFloor" type="LengthType" minOccurs="0">
 				<xsd:annotation>
-					<xsd:documentation>Height ofindow from floor of of DECK.</xsd:documentation>
+					<xsd:documentation>Height of window from floor of of DECK.</xsd:documentation>
 				</xsd:annotation>
 			</xsd:element>
 			<xsd:element name="VehicleSide" type="VehicleSideEnumeration" minOccurs="0">

diff --git a/xsd/netex_framework/netex_reusableComponents/netex_environment_version.xsd b/xsd/netex_framework/netex_reusableComponents/netex_environment_version.xsd
@@ -60,7 +60,7 @@ Rail transport, Roads and Road transport
 				<Type>Standard</Type>
 			</Metadata>
 		</xsd:appinfo>
-		<xsd:documentation>Shared PATH  features Model.</xsd:documentation>
+		<xsd:documentation>Shared PATH features model.</xsd:documentation>
 	</xsd:annotation>
 	<!-- ======PATH DESCRIPTION ================================================== -->
 	<xsd:group name="PathDescriptionGroup">
@@ -126,7 +126,7 @@ Rail transport, Roads and Road transport
 	</xsd:complexType>
 	<xsd:group name="AccessSummaryGroup">
 		<xsd:annotation>
-			<xsd:documentation>Elements of a NAVIGATION PATH.</xsd:documentation>
+			<xsd:documentation>Elements of an ACCESS SUMMARY.</xsd:documentation>
 		</xsd:annotation>
 		<xsd:sequence>
 			<xsd:element name="AccessFeatureType" type="AccessFeatureEnumeration">

diff --git a/xsd/netex_framework/netex_reusableComponents/netex_vehicleType_version.xsd b/xsd/netex_framework/netex_reusableComponents/netex_vehicleType_version.xsd
@@ -1090,7 +1090,7 @@ Rail transport, Roads and Road transport
 			<xsd:element ref="TransportTypeRef" minOccurs="0"/>
 			<xsd:element name="Range" type="LengthType" minOccurs="0">
 				<xsd:annotation>
-					<xsd:documentation>Range when full fueeled /charged +v2.0.</xsd:documentation>
+					<xsd:documentation>Range when full fuelled /charged. +v2.0</xsd:documentation>
 				</xsd:annotation>
 			</xsd:element>
 			<xsd:element name="FullCharge" type="WattHoursType" minOccurs="0">

diff --git a/xsd/netex_part_1/part1_ifopt/netex_ifopt_equipmentAccess_support.xsd b/xsd/netex_part_1/part1_ifopt/netex_ifopt_equipmentAccess_support.xsd
@@ -166,7 +166,7 @@ Rail transport, Roads and Road transport
 			</xsd:enumeration>
 			<xsd:enumeration value="dropDownShutter">
 				<xsd:annotation>
-					<xsd:documentation>Drop dwon shutter - eg fopr passenger vehicle or luggage wagon.</xsd:documentation>
+					<xsd:documentation>Drop down shutter - e.g. for passenger vehicle or luggage wagon.</xsd:documentation>
 				</xsd:annotation>
 			</xsd:enumeration>
 			<xsd:enumeration value="other">

diff --git a/xsd/netex_part_1/part1_ifopt/netex_ifopt_navigationPath_version.xsd b/xsd/netex_part_1/part1_ifopt/netex_ifopt_navigationPath_version.xsd
@@ -119,7 +119,7 @@ Rail transport, Roads and Road transport
 					<xsd:element ref="SiteNavigation"/>
 					<xsd:element ref="NavigationPath">
 						<xsd:annotation>
-							<xsd:documentation>A designated path between two PLACEs. May include an Ordered sequence of references to PATH LINKS.</xsd:documentation>
+							<xsd:documentation>A designated path between two PLACEs. May include an ordered sequence of references to PATH LINKS.</xsd:documentation>
 						</xsd:annotation>
 					</xsd:element>
 					<xsd:element ref="SitePathLink">

diff --git a/xsd/netex_part_1/part1_ifopt/netex_ifopt_site_support.xsd b/xsd/netex_part_1/part1_ifopt/netex_ifopt_site_support.xsd
@@ -369,7 +369,7 @@ Rail transport, Roads and Road transport
 	<!-- ======================================================================= -->
 	<xsd:simpleType name="EntranceEnumeration">
 		<xsd:annotation>
-			<xsd:documentation>Allowed values for doors status.</xsd:documentation>
+			<xsd:documentation>Allowed values for ENTRANCE type.</xsd:documentation>
 		</xsd:annotation>
 		<xsd:restriction base="xsd:string">
 			<xsd:enumeration value="opening"/>

diff --git a/xsd/netex_part_1/part1_tacticalPlanning/netex_servicePattern_version.xsd b/xsd/netex_part_1/part1_tacticalPlanning/netex_servicePattern_version.xsd
@@ -889,7 +889,7 @@ Rail transport, Roads and Road transport
 			</xsd:group>
 			<xsd:group ref="StopPointInPatternAdvertisementGroup">
 				<xsd:annotation>
-					<xsd:documentation>Advertisement Elements for info about publicising STOP POINT IN JOURNEY PATTERN. +V1.1</xsd:documentation>
+					<xsd:documentation>Advertisement elements for publicising STOP POINT IN JOURNEY PATTERN. +V1.1</xsd:documentation>
 				</xsd:annotation>
 			</xsd:group>
 		</xsd:sequence>

diff --git a/xsd/netex_part_2/part2_journeyTimes/netex_datedVehicleJourney_version.xsd b/xsd/netex_part_2/part2_journeyTimes/netex_datedVehicleJourney_version.xsd
@@ -190,7 +190,7 @@ Rail transport, Roads and Road transport
 			</xsd:element>
 			<xsd:element name="vehiclePreassignments" type="vehiclePreassignments_RelStructure" minOccurs="0">
 				<xsd:annotation>
-					<xsd:documentation>Vehicle Preassignments  for JOURNEY.</xsd:documentation>
+					<xsd:documentation>Vehicle preassignments for JOURNEY.</xsd:documentation>
 				</xsd:annotation>
 			</xsd:element>
 		</xsd:sequence>