Skip to content

Fix spelling errors in part3_fares documentation and comments#1039

Merged
atibaut merged 4 commits into
v2.0from
fix/part3-fares-doc-typos
Jul 10, 2026
Merged

Fix spelling errors in part3_fares documentation and comments#1039
atibaut merged 4 commits into
v2.0from
fix/part3-fares-doc-typos

Conversation

@atibaut

@atibaut atibaut commented Jul 9, 2026

Copy link
Copy Markdown
Contributor

Dear NeTExians,

While working on the NAPCORE Helpdesk app, which uses the NeTex documentation as the source of truth, I found spelling mistakes that can be easily corrected without breaking anything.

Therefore, this PR fixes spelling errors in the xsd/netex_part_3/part3_fares schemas. All changes are confined to <xsd:documentation> text and XML comments — no schema components (elements, types, enumeration values) are modified, so there is no impact on validation or backward compatibility.

Changes

  • ENTIITYENTITY in section-divider comments (17 occurrences across the fares files)
  • "Factor value assoictaed with init." → "Factor value associated with the unit." (netex_fareStructure_version.xsd, netex_geographicStructureFactor_version.xsd, netex_timeStructureFactor_version.xsd)
  • "Units in which steps atre counted" → "…are counted" (netex_usageParameterTravel_version.xsd)
  • "Number of units. If only ine." → "…If only one." (netex_fareProduct_version.xsd)
  • "Other products to which SALE DISCONT applies to" → "Other products to which SALE DISCOUNT RIGHT applies" (netex_fareProduct_version.xsd)
  • "OPTIMISED version whcih can be be used only in line assues ID of comtainign context" → "…which can be used only in line; assumes ID of containing context" (netex_calculationParameters_version.xsd)
  • "parameters fo the same type" → "parameters of the same type" (netex_accessRightParameter_version.xsd)
  • "chargable" → "chargeable" (netex_accessRightParameter_version.xsd)
  • "specifed" → "specified" (netex_usageParameterAfterSales_support.xsd, netex_usageParameterTravel_support.xsd)
  • "FARE EDMAND FACTOR" → "FARE DEMAND FACTOR" (netex_qualityStructureFactor_version.xsd)
  • "difference beteen" → "difference between", "adding the the Adjustment" → "adding the Adjustment" (netex_farePrice_version.xsd)
  • "changiing the numbe of people" → "changing the number of people" (netex_usageParameterEligibility_version.xsd)

Deliberately left out (breaking change!)

  • The Exchangable* misspelling (e.g. ExchangableToEnumeration, ExchangableTo, IsExchangable, ExchangableFrom*/ExchangableUntil* and the matching enumeration values in netex_entity_support.xsd) is not fixed here: those are schema component names used in instance documents, so renaming them is a breaking change that needs a separate decision (e.g. deprecated aliases at the next version).

Verification

  • All changed files are well-formed XML.
  • NeTEx_publication.xsd compiles and examples/functions/fares/Netex_51.1_Bus_SimpleFares_PointToPoint_SingleProduct.xml validates against it (xmllint).

@atibaut atibaut marked this pull request as ready for review July 9, 2026 20:16
Copilot AI review requested due to automatic review settings July 9, 2026 20:16

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This pull request improves the NeTEx Part 3 (fares) XSD documentation quality by correcting spelling/wording mistakes in <xsd:documentation> and XML comments, without changing any schema components (types, elements, enums), preserving validation/backward compatibility.

Changes:

  • Corrects repeated “ENTIITY” section-divider comment typos to “ENTITY” across multiple fares XSDs.
  • Fixes several documentation typos/phrasing issues (e.g., “assoictaed” → “associated”, “atre” → “are”, “ine” → “one”, etc.).
  • Improves clarity of a few documentation sentences (e.g., SALE DISCOUNT RIGHT wording, Optimised context wording).

Reviewed changes

Copilot reviewed 21 out of 21 changed files in this pull request and generated 3 comments.

Show a summary per file
File Description
xsd/netex_part_3/part3_fares/netex_validableElement_version.xsd Fixes “ENTIITY” typo in section divider comment.
xsd/netex_part_3/part3_fares/netex_usageParameterTravel_version.xsd Fixes documentation typo (“atre” → “are”).
xsd/netex_part_3/part3_fares/netex_usageParameterTravel_support.xsd Fixes documentation typo (“specifed” → “specified”).
xsd/netex_part_3/part3_fares/netex_usageParameterEligibility_version.xsd Fixes documentation typos (“changiing/numbe” → “changing/number”).
xsd/netex_part_3/part3_fares/netex_usageParameterAfterSales_support.xsd Fixes documentation typo (“specifed” → “specified”).
xsd/netex_part_3/part3_fares/netex_usageParameter_version.xsd Fixes “ENTIITY” typo in section divider comment.
xsd/netex_part_3/part3_fares/netex_typeOfTravelDocument_version.xsd Fixes “ENTIITY” typo in section divider comment.
xsd/netex_part_3/part3_fares/netex_timeStructureFactor_version.xsd Fixes “ENTIITY” typo and documentation text (“assoictaed…”).
xsd/netex_part_3/part3_fares/netex_salesOfferPackage_version.xsd Fixes “ENTIITY” typo in section divider comment.
xsd/netex_part_3/part3_fares/netex_salesDistribution_version.xsd Fixes “ENTIITY” typo in section divider comment.
xsd/netex_part_3/part3_fares/netex_qualityStructureFactor_version.xsd Fixes “ENTIITY” typo and documentation text (“EDMAND” → “DEMAND”).
xsd/netex_part_3/part3_fares/netex_geographicStructureFactor_version.xsd Fixes “ENTIITY” typo and documentation text (“assoictaed…”).
xsd/netex_part_3/part3_fares/netex_fareTable_version.xsd Fixes duplicated section divider typos (“ENTIITY” → “ENTITY”).
xsd/netex_part_3/part3_fares/netex_fareStructureElement_version.xsd Fixes “ENTIITY” typo in section divider comment.
xsd/netex_part_3/part3_fares/netex_fareStructure_version.xsd Fixes documentation text (“assoictaed…” → “associated…”).
xsd/netex_part_3/part3_fares/netex_fareSeries_version.xsd Fixes “ENTIITY” typo in section divider comment.
xsd/netex_part_3/part3_fares/netex_fareProduct_version.xsd Fixes “ENTIITY” typo and documentation wording (“SALE DISCOUNT RIGHT…”, “ine” → “one”).
xsd/netex_part_3/part3_fares/netex_farePrice_version.xsd Fixes documentation typos (“beteen”, “the the” duplication).
xsd/netex_part_3/part3_fares/netex_distanceMatrixElement_version.xsd Fixes “ENTIITY” typo in section divider comment.
xsd/netex_part_3/part3_fares/netex_calculationParameters_version.xsd Fixes “ENTIITY” typo and documentation wording (“whcih…”, “comtainign…”, etc.).
xsd/netex_part_3/part3_fares/netex_accessRightParameter_version.xsd Fixes “ENTIITY” typo and documentation typos (“chargable”, “fo” → “of”).

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread xsd/netex_part_3/part3_fares/netex_usageParameterTravel_support.xsd Outdated
Comment thread xsd/netex_part_3/part3_fares/netex_calculationParameters_version.xsd Outdated
Comment thread xsd/netex_part_3/part3_fares/netex_calculationParameters_version.xsd Outdated
@atibaut atibaut mentioned this pull request Jul 9, 2026
atibaut and others added 2 commits July 9, 2026 22:23
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>

@skinkie skinkie left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I guess we all know who wrote them.

@atibaut atibaut added the typo Typo (comment or mispelling) correction without any technical impact label Jul 9, 2026
@atibaut atibaut merged commit 032493a into v2.0 Jul 10, 2026
1 check passed
@atibaut atibaut deleted the fix/part3-fares-doc-typos branch July 10, 2026 18:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

typo Typo (comment or mispelling) correction without any technical impact

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants