docs: address PR review feedback — consistency, grammar, and architecture alignment#2
Merged
MathiasVDA merged 2 commits into002-train-path-calculationfrom Mar 20, 2026
Merged
Conversation
… architecture docs Co-authored-by: MathiasVDA <15101339+MathiasVDA@users.noreply.github.com> Agent-Logs-Url: https://github.com/Matdata-eu/tp-lib/sessions/02a3fc18-73f4-4e65-93fe-e859f0d191c0
Copilot
AI
changed the title
[WIP] Add documentation for feature 002 train path calculation
docs: address PR review feedback — consistency, grammar, and architecture alignment
Mar 20, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Several inconsistencies across docs, specs, and CI introduced in the 002-train-path-calculation PR needed correction before implementation begins.
Changes
Consistency fixes
cutoff_distancedefault was50min spec/lib-api docs but500.0in theDefaultimpl — unified to500macrossspec.md(4 occurrences),lib-api.mddoc commentREADME.mdstated "four output files" butDEBUG.mddocuments seven — updated to "debug output files"contracts/cli.mdwas missing--crswhich exists in the actual CLI and is used in all example commands acrosstest-data/README.mdandDEBUG.md— added as an optional Input OptionArchitecture alignment
tasks.mdPhase 4 still described the superseded bidirectional greedy approach (forward/backward construction + agreement) — replaced with HMM/Viterbi-aligned tasks (candidate_netelements_for_positions,emission_probability,transition_probability,viterbi_decode_path,insert_bridge_segments)CONTRIBUTING.mdreferencedconstruction.rs/selection.rs— updated toprobability.rs/viterbi.rsto reflect current module structurealgorithm.mdstated the algorithm produces "a single unbroken subsequence for all GNSS input" — clarified that carry-forward applies within a window, and FR-027 (break detection + reinitialization) is handled by higher-level control logic across windowsMinor fixes
README.md)test-data/README.md, 2 occurrences)coverage.yml: Codecov upload now skipped for fork PRs whereCODECOV_TOKENis unavailable, preventing spurious CI failures🔒 GitHub Advanced Security automatically protects Copilot coding agent pull requests. You can protect all pull requests by enabling Advanced Security for your repositories. Learn more about Advanced Security.