Skip to content

Clarify event_count usage and APC data guidance#248

Open
chrisyamas wants to merge 2 commits intodevelopfrom
feature/issue-236-event-count
Open

Clarify event_count usage and APC data guidance#248
chrisyamas wants to merge 2 commits intodevelopfrom
feature/issue-236-event-count

Conversation

@chrisyamas
Copy link
Copy Markdown
Contributor

@chrisyamas chrisyamas commented Dec 30, 2025

Summary

This change clarifies the passenger_events.event_count field documentation to provide guidance on proper usage, distinguishing between individual passenger events and aggregated APC counts.

Resolves #236

Changes

  • spec/passenger_events.schema.json updated event_count description to:
    • specify that values > 1 should only be used for truly simultaneous events (e.g., parent carrying child through doorway)
    • direct aggregated APC counts to stop_visits table instead, and
    • clarify that a value of 0 indicates a recorded event with no passengers, distinct from null/missing data
  • CHANGELOG.md added entry under [Unreleased]

Reason for change

The original description was ambiguous about when to use event_count > 1 vs. recording aggregated data. Some TIDES implementers have noted the lack of clarity for whether to put APC summary data (for instance, "6 passengers boarded at this stop") into passenger_events or stop_visits.

This clarification establishes that passenger_events is for discrete, instantaneous events, while stop_visits is the appropriate destination for aggregated counts.

- For reference, see related discussion in Issue #236 and Fall 2025 TIDES Issues Working Group notes from December 1

Review checklist

Per TIDES change management policy, the following must be met before feature branch changes can merge to develop branch:

  • All JSON files validate
  • Reviewed and approved by 2+ contributors or board members

@chrisyamas chrisyamas added this to the v2.0 milestone Dec 30, 2025
@chrisyamas chrisyamas self-assigned this Dec 30, 2025
@chrisyamas chrisyamas requested review from a team as code owners December 30, 2025 19:07
@chrisyamas chrisyamas added 📙 docs Elaborating or updating the documentation – inline or otherwise 📄 spec Pertains to the specification itself 📝 non-normative Non-normative changes can be approved by other contributors labels Dec 30, 2025
@github-actions
Copy link
Copy Markdown
Contributor

Documentation available at: http://tides-transit.github.io/TIDES/feature/issue-236-event-count

@chrisyamas chrisyamas changed the base branch from main to develop January 2, 2026 16:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

📙 docs Elaborating or updating the documentation – inline or otherwise 📝 non-normative Non-normative changes can be approved by other contributors 📄 spec Pertains to the specification itself

Projects

None yet

Development

Successfully merging this pull request may close these issues.

🐛📄 – Clarify event_count usage in passenger_events

2 participants