Skip to content

Rename duration fields with explicit suffix - #249

Open
chrisyamas wants to merge 4 commits into
developfrom
feature/issue-237-duration-naming
Open

Rename duration fields with explicit suffix#249
chrisyamas wants to merge 4 commits into
developfrom
feature/issue-237-duration-naming

Conversation

@chrisyamas

@chrisyamas chrisyamas commented Dec 30, 2025

Copy link
Copy Markdown
Contributor

Summary

This is a breaking change as it renames three duration fields in stop_visits from *_time to *_duration suffix to clearly distinguish them from timestamp fields like actual_arrival_time.

Resolves #237

Changes

  • spec/stop_visits.schema.json renamed fields:
    • ramp_deployed_time --> ramp_deployed_duration
    • kneel_deployed_time --> kneel_deployed_duration
    • lift_deployed_time --> lift_deployed_duration
  • Standardized description phrasing to "Duration of time a [device] is deployed, in seconds."
  • CHANGELOG.md added BREAKING change entry under [Unreleased]

Reason for this change

The _time suffix creates confusion because the same table uses _time for actual timestamps (e.g., actual_arrival_time, schedule_departure_time). Users shouldn't have to read the description to know whether a field contains a point-in-time or a duration.\

The new _duration suffix makes the field type immediately clear (and aligns with common naming conventions where _time indicates timestamps and _duration indicates elapsed time).

- See related discussion in Issue #237 and Fall 2025 TIDES Issues Working Group notes from December 10.

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

Community review status (updated August 27, 2026)

How community review works: Per the TIDES Change Management Policy, a proposal moves forward once at least three TIDES Contributors outside the originating working group publicly comment with a score: Accepted, Accepted with minor changes, or Substantially revised. A few sentences with your read of the proposal is a complete review.

Originating working group (Fall 2025 Issues Working Group, December 1 and 10, 2025 sessions): Christopher Yamas, Gabriel Sánchez Martínez, Ian Thistle, Jay Gordon, John Levin, Joey Reid, Spenser Sutinen. Their work is reflected in the proposal itself; community review comes from Contributors beyond this group.

Review so far: @lauriemerrell has approved this PR (Accepted). @mpaine-act shared naming feedback in #237 and a short scored comment here would add that review to the record.

Thanks to everyone who has weighed in on this proposal; it is moving into final consideration for v2.0. Further comments are always welcome.

@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 20:53
@chrisyamas chrisyamas added 📄 spec Pertains to the specification itself 🔄 normative change A normative change requires approval of TIDES Board labels Dec 30, 2025
@github-actions

Copy link
Copy Markdown
Contributor

@chrisyamas chrisyamas changed the title Feature/issue 237 duration naming Rename duration fields with explicit suffix Dec 30, 2025
@jlstpaul

jlstpaul commented Jan 5, 2026

Copy link
Copy Markdown
Contributor

Also modify samples/template/TIDES/stop_visits.csv

@github-actions

Copy link
Copy Markdown
Contributor

Data Validation Report

Sample Status
./samples/template/TIDES ✔️

@chrisyamas

Copy link
Copy Markdown
Contributor Author

Also modify samples/template/TIDES/stop_visits.csv

@jlstpaul, I updated samples/template/TIDES/stop_visits.csv to rename ramp_deployed_time to ramp_deployed_duration, kneel_deployed_time to kneel_deployed_duration, and lift_deployed_time to lift_deployed_duration in the sample header. would you be willing to submit a formal GitHub review?

@CTRAN-Sutinen CTRAN-Sutinen left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Looks good

@jaygordon jaygordon 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.

Looks good, thanks!

@github-actions

Copy link
Copy Markdown
Contributor

Data Validation Report

Sample Status
./samples/template/TIDES ✔️

@chrisyamas chrisyamas mentioned this pull request Jul 30, 2026
2 tasks
@chrisyamas

Copy link
Copy Markdown
Contributor Author

@mpaine-act in #237 you made the case for keeping field names unabbreviated and self-documenting, which is where this landed, _duration suffixes rather than _dur_s.

If the outcome works for you, a short comment here with a score (Accepted / Accepted with minor changes / Substantially revised) counts toward community review on this one.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

🔄 normative change A normative change requires approval of TIDES Board 📄 spec Pertains to the specification itself

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants