OpenRailAssociation / OpenRailAssociation/osrd
core: stdcm: clarify the different times / durations
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 660
- Forks
- 87
- Avg merge
- 3d 4h
- Merged PRs (30d)
- 269
Description
We need to handle a lot of different "time" values, some of which have been added along the way. The naming is now very confusing. Specifically, the most confusing one is "travel time", which excludes the stop duration. @bougue-pe suggests to rename it to "movement duration", which does sound better. We also need a way to name the total duration of both movement and stop time, "travel time" is too ambiguous for that (especially since it currently describes something different).
We also use both "time" and "duration" interchangeably, which doesn't help.
We need to think about all that naming and rename all variables in a single PR.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by inventorying the core stdcm variables that represent time and duration, then trace their usages to understand which values include stop time and which represent movement only. Agree on consistent terminology before renaming everything in one change; done means the naming clearly distinguishes movement duration from total duration and no old terminology remains in scope.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- backend
- Issue type
- Refactor
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100